Docs
API ReferenceReferenceUser groups

List user groups

GET
/user-groups

Every group in the organization, alphabetical, with member counts.

Requires the end_users:read scope.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/user-groups"
{  "userGroups": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "createdAt": "2019-08-24T14:15:22Z",      "memberCount": 0    }  ]}