Skip to main content
GET
Returns all HR and API integrations connected to your company account, including connection health, last sync details, and whether a manual sync can be triggered. Use the types filter to separate HR system integrations from direct API push integrations.

Query Parameters

integer
default:"1"
Page number to return. Starts at 1.
integer
default:"10"
Number of results per page. Maximum is 100.
string
default:"desc"
Sort direction. Allowed values: asc, desc.
string
default:"id"
Field to sort results by. Allowed values: id, createdAt, updatedAt.
integer[]
Filter to specific integration IDs.
string[]
Filter by integration type. Allowed values: hr-integration, api-integration.

Response

object
required

Authorizations

Authorization
string
header
required

HTTP Basic Auth using your API key credentials. Use the username and password issued from the Developer Portal. Encode them as Base64(username:password) and pass in the Authorization: Basic <token> header.

Query Parameters

page
integer | null
default:1

Page number to return. Starts at 1.

Required range: x >= 0
perPage
integer | null
default:10

Number of results per page. Maximum is 100.

Required range: 0 <= x <= 100
sortOrder
enum<string> | null
default:desc

Sort direction — asc for ascending, desc for descending.

Available options:
asc,
desc
sortField
enum<string> | null
default:id

Field to sort results by.

Available options:
id,
createdAt,
updatedAt
ids
integer[] | null

Filter to specific integration IDs.

Required range: x >= 0
types
enum<string>[] | null

Filter by integration type: hr-integration (third-party HR system) or api-integration (direct API push).

Available options:
hr-integration,
api-integration

Response

200 - application/json

A paginated list of HR integrations.

data
object
required