HRIS API
Welcome to the HRIS API. You can use this API to access all HRIS API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the HRIS API.
You can use this API to access all HRIS API endpoints.
Base URL
The base URL for all API requests is https://unify.apideck.com
Headers
Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.
| Name | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |
| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |
| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |
| Authorization | String | Yes | Bearer KEY |
Authorization
You can interact with the API through the authorization methods below.
-->
Pagination
All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.
To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.
In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |
| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |
Response Body
| Name | Type | Description |
|---|---|---|
| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |
| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |
| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |
| meta.items_on_page | Number | Number of items returned in the data property of the response |
| links.previous | String | Link to navigate to the previous page of results through the API |
| links.current | String | Link to navigate to the current page of results through the API |
| links.next | String | Link to navigate to the next page of results through the API |
⚠️ meta.cursors.previous/links.previous is not available for all connectors.
SDKs and API Clients
We currently offer a Node.js, PHP, Python and .NET SDK.
Need another SDK? Request the SDK of your choice.
Debugging
Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.
Errors
The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.
| Code | Title | Description … |
Endpoints 25
Employees
- GETList Employees
/hris/employees?raw=false&cursor=string&limit=20&filter={"company_id":"1234","email":"elon@tesla.com","first_name":"Elon","last_name":"Musk","title":"Manager","manager_id":"1234","employment_status":"active","employee_number":"123456-AB","department_id":"1234","city":"San Francisco","country":"US"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atApideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that… - POSTCreate Employee
/hris/employees?raw=falseCreate Employee - GETGet Employee
/hris/employees/:id?raw=false&fields=id,updated_at&filter={"company_id":"1234"}&pass_through={"search":"San Francisco"}Get Employee - DELETEDelete Employee
/hris/employees/:id?raw=falseDelete Employee - PATCHUpdate Employee
/hris/employees/:id?raw=falseUpdate Employee
Companies
- GETList Companies
/hris/companies?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList Companies - POSTCreate Company
/hris/companies?raw=falseCreate Company - GETGet Company
/hris/companies/:id?raw=false&fields=id,updated_atGet Company - DELETEDelete Company
/hris/companies/:id?raw=falseDelete Company - PATCHUpdate Company
/hris/companies/:id?raw=falseUpdate Company
Departments
- GETList Departments
/hris/departments?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList Departments - POSTCreate Department
/hris/departments?raw=falseCreate Department - GETGet Department
/hris/departments/:id?raw=false&fields=id,updated_atGet Department - DELETEDelete Department
/hris/departments/:id?raw=falseDelete Department - PATCHUpdate Department
/hris/departments/:id?raw=falseUpdate Department
Payrolls
- GETList Payroll
/hris/payrolls?raw=false&filter={"start_date":"2022-04-08","end_date":"2022-04-21"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList Payroll - GETGet Payroll
/hris/payrolls/:payroll_id?raw=false&fields=id,updated_atGet Payroll
Employee Payrolls
- GETList Employee Payrolls
/hris/payrolls/employees/:employee_id?raw=false&filter={"start_date":"2022-04-08","end_date":"2022-04-21"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList payrolls for employee - GETGet Employee Payroll
/hris/payrolls/employees/:employee_id/payrolls/:payroll_id?raw=false&fields=id,updated_atGet payroll for employee
Employee Schedules
- GETList Employee Schedules
/hris/schedules/employees/:employee_id?raw=false&pass_through={"search":"San Francisco"}&fields=id,updated_atList schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee.
Time Off Requests
- GETList Time Off Requests
/hris/time-off-requests?raw=false&cursor=string&limit=20&filter={"start_date":"2022-04-08","end_date":"2022-04-21","updated_since":"2020-09-30T07:43:32.000Z","employee_id":"1234","time_off_request_status":"approved","company_id":"1234"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList Time Off Requests - POSTCreate Time Off Request
/hris/time-off-requests?raw=falseCreate Time Off Request - GETGet Time Off Request
/hris/time-off-requests/employees/:employee_id/time-off-requests/:id?raw=false&fields=id,updated_atGet Time Off Request - DELETEDelete Time Off Request
/hris/time-off-requests/employees/:employee_id/time-off-requests/:id?raw=falseDelete Time Off Request - PATCHUpdate Time Off Request
/hris/time-off-requests/employees/:employee_id/time-off-requests/:id?raw=falseUpdate Time Off Request
API details
- Base URL
https://unify.apideck.com- Authentication
- An API key in the Authorization header
- Operations
- 25 operations on 13 pathsGET 13POST 4PATCH 4DELETE 4
- Main resources
- Companies 5Departments 5Employees 5Time Off Requests 5Employee Payrolls 2Payrolls 2Employee Schedules 1
- Description format
- OpenAPI 3.0.0, API version
10.83.0 - Links
- Documentation · OpenAPI document · Support
How to test the HRIS API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the HRIS API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Employees” (GET /hris/employees?raw=false&cursor=string&limit=20&filter={"company_id":"1234","email":"elon@tesla.com","first_name":"Elon","last_name":"Musk","title":"Manager","manager_id":"1234","employment_status":"active","employee_number":"123456-AB","department_id":"1234","city":"San Francisco","country":"US"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the HRIS API?
Welcome to the HRIS API. You can use this API to access all HRIS API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com… It is listed under Developer tools and has 25 endpoints.
Who publishes the HRIS API?
It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.
What is the base URL of the HRIS API?
Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.
How do I authenticate with the HRIS API?
With an API key in the Authorization header.
How many endpoints does the HRIS API have?
25 operations on 13 paths (13 GET, 4 POST, 4 PATCH, 4 DELETE). The largest groups are Companies, Departments, Employees, Time Off Requests.
Is forking the HRIS API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.