Skip to main content
GET
List connectors

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

page
number | null

The 1-based page number to fetch. Omit both page and page_size to fetch all connectors at once.

Required range: x >= 1
page_size
number | null
default:25

The number of connectors to return per page.

Required range: 1 <= x <= 100
key
string[] | null

Filter to connectors with any of these keys (comma-separated or repeated, e.g. ?key=workday,bamboohr).

category
string[] | null

Filter to connectors in any of these categories (comma-separated or repeated, e.g. ?category=hris,ats).

expand
string | null

A comma-separated list of additional fields to expand. Supported values: accounts_count (the number of accounts linked to each connector) and connector_profiles_count (the number of connector profiles configured for each connector). These require database aggregation, so they are returned as null unless requested. When either is requested, connectors are sorted by combined usage (accounts + connector profiles, highest first) before the alphabetical order.

Example:

"accounts_count,connector_profiles_count"

Response

The connectors were retrieved.

page
number
required

The current page number.

page_size
number
required

The number of connectors per page.

total
number
required

The total number of connectors matching the request.

data
object[]
required

The connectors on this page.