Skip to main content
GET
/
api
/
hris
/
v1
/
connectors
Get Hris Connectors
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/connectors \
  --header 'Authorization: Bearer <token>'
{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": true,
      "integration_slug": "<string>",
      "end_user": "<string>",
      "origin_id": "user_123",
      "sync_status": "Done",
      "last_sync_start_time": "2024-10-16T00:00:00Z",
      "next_sync_start_time": "2024-10-17T00:00:00Z",
      "connector_token": "<string>",
      "relink_needed_at": "2024-10-17T00:00:00Z",
      "is_test_connector": true,
      "completed_at": "2024-10-17T00:00:00Z",
      "created_at": "2023-11-07T05:31:56Z",
      "sync_progress": 42,
      "total_employees": 128,
      "active_employees": 120,
      "avg_sync_duration": "15 min 30 sec"
    }
  ]
}

​
Overview

This is a demo of how to use the Connectors API to get all connectors for specific category. This guide will help you understand the endpoints available and how to utilize them effectively.
You can also access connectors for different categories using https://api.bindbee.dev/api/{category}/v1/connectors. To retrieve ATS connectors, use: https://api.bindbee.dev/api/ats/v1/connectors and to retrieve LMS connectors, use: https://api.bindbee.dev/api/lms/v1/connectors

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
connector_token
string

The connector token for the connector

Example:

"i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"

​
is_active
boolean | null

Filter connectors by active status

Example:

true

​
origin_id
string | null

Filter connectors by end user origin ID

Example:

"user_123"

​
page_size
integer
default:50

Number of results to return per page. Maximum size is 200.

Required range: 1 <= x <= 200
​
cursor
string

The pagination cursor value.

Response

Successful Response

​
cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

​
page_size
integer
required

Indicates the count of items in the response

Example:

50

​
items
HrisConnectorResponse · object[]
required

List of items in the current response

Example:
{}