v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Connector

Get Ats Connectors

Returns a list of ATS connectors

get/api/ats/v1/connectors

Query parameters

connector_tokenstring

The connector token for the connector

Example:i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T

The connector token for the connector

is_activeboolean nullable

Filter connectors by active status

Example:true

Filter connectors by active status

origin_idstring nullable

Filter connectors by end user origin ID

Example:user_123

Filter connectors by end user origin ID

page_sizeinteger

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

cursorstring

The pagination cursor value.

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

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"
    }
  ]
}