Skip to main content
GET
List Groups

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Query Parameters

external_id
string

Partner-only. Filter results to the group mapped to this partner-supplied identifier. Accepted only when authenticating with a partner API key — direct customers that pass this parameter receive 403 Forbidden. Exact match, scoped to your organization; unmapped IDs return an empty array.

Minimum string length: 1

Response

Successful response with list of groups. Partner responses include an externalId field on each item (string or null); direct-customer responses omit the field entirely.

groups
object[]
required