An API for accessing Humi employee data in third-party applications
Our Open API is in a closed beta phase. We are more than happy to provide a token to explore current functionality. However, as this is still actively in development -- there may be unexpected changes, downtime, or other complications.
Use at your own risk. If you have additional questions, desired use cases, or comments, our product team is interested to speak to you. Please contact support@humi.ca with any questions.
- Introduction
- Getting Started
- Responses
- Requests
- Examples
- Domain
- Endpoints
- Webhooks
- Humi Partners API Token
The Humi Partners API allows access to Humi employee data in a third-party application.
The API follows the JSON:API spec.
Before using the API, you must obtain a Humi Partners API Token.
To access data, make a GET request to one of the available endpoints and include your token in the Authorization header. Ex: Authorization: Bearer your-token-here
The results will be returned following the JSON:API spec.
Requests must follow the JSON:API spec.
Request must be to one of the available endpoints.
Responses follow the JSON:API spec.
The Partners API Domain is partners.humi.ca. Only https is supported.
Endpoints for retrieving Employee information.
- Employee Index :
GET /v1/employees - Employee Show :
GET /v1/employees/:employeeId
Endpoints for retrieving Time Off information.
- Time Off Index :
GET /v1/timeoff - Time Off Show :
GET /v1/timeoff/:employeeId
Employee events that trigger webhooks.
- EmployeeCreated :
EmployeeCreated Event - EmployeeUpdated :
EmployeeUpdated Event - EmployeeTerminated :
EmployeeTerminated Event - EmployeeDeleted :
EmployeeDeleted Event
Company events that trigger webhooks.
- CompanyCreated :
CompanyCreated Event - CompanyUpdated :
CompanyUpdated Event
curl -H "Authorization: Bearer valid-token-here" https://partners.humi.ca/v1/employees?page%5Bsize%5D=5&page%5Bnumber%5D=2
There is a sample node client in sample-node-client.js.
Humi Partners API Tokens are used to access Humi data. Each token allows you access to only one company in Humi. They do not expire, but can be revoked by Humi.
Humi Partners API Tokens should never be shared, published, or committed.
Humi Partners API Tokens are issued by Humi. To request one, please contact support@humi.ca and use the subject Requesting Humi Partners API Token.