Skip to main content
GET
List connector profiles

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 connector profiles at once.

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

The number of connector profiles to return per page.

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

Filter to connector profiles for any of these connector keys (comma-separated or repeated, e.g. ?connector_key=workday,bamboohr).

active
boolean | null

Filter connector profiles by their active state.

Example:

true

expand
string | null

A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile) and enabled_actions_count (how many of that version's actions this profile enables). These are returned as null unless requested.

Example:

"connector,version"

Response

The connector profiles were retrieved.

page
number
required

The current page number.

page_size
number
required

The number of connector profiles per page.

total
number
required

The total number of connector profiles matching the request.

data
object[]
required

The connector profiles on this page.