HRIS API API

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` We also provide a [Mock API](https://developers.apideck.com/mock-api) that can be used for testing purposes: `https://mock-api.apideck.com` ## Headers Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | 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 API KEY | ## Authorization You can interact with the API through the authorization methods below. <!-- ReDoc-Inject: <security-definitions> --> ## 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](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK. Need another SDK? [Request the SDK of your choice](https://integrations.apideck.com/request). ## 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 yo

HRIS API is a development API from apideck.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 27 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Development

Base URL

https://unify.apideck.com

Version

9.3.0

Endpoints

27

OpenAPI

Specification ↗

Spec updated

2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://unify.apideck.com/hris/companies" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://unify.apideck.com/hris/companies", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://unify.apideck.com/hris/companies",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions