BIbindbee
Connector

Get Ats Connectors

Changed on

Returns a list of ATS connectors

get/api/ats/v1/connectors

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

idsstring nullable

The ID of the connectors to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
connector_tokenstring nullable

The connector token for the connector

Example:i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
is_activeboolean nullable

Filter connectors by active status

Example:true
origin_idstring nullable

Filter connectors by end user origin ID

Example:user_123
page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "is_active": true,
      "integration_slug": "ukg-pro",
      "end_user": "Acme Corp.",
      "origin_id": "user_123",
      "last_sync_start_time": "2024-10-16T00:00:00Z",
      "next_sync_start_time": "2024-10-17T00:00:00Z",
      "connector_token": "LJITuCJFqpGXeKfZtn4I9ZcahzA-lkCSO6uhDKj5xw9EzPL96qk7ObgIHQQ1GnxH",
      "relink_needed_at": "2024-10-17T00:00:00Z",
      "completed_at": "2024-10-17T00:00:00Z",
      "created_at": "2024-10-17T00:00:00Z"
    }
  ]
}

Changes

  • 54a221a29f68Revision changes
    • info

      added the new optional query request parameter ids

  • a606b0cf18c9Revision changes
    • info

      query request parameter connector_token list-of-types was widened by adding types null

    • info

      query request parameter cursor list-of-types was widened by adding types null

    • info

      for the query request parameter connector_token, the type was generalized from string to no type

    • info

      for the query request parameter cursor, the type was generalized from string to no type