ContactGroups

List contact groups

Returns a paginated list of contact groups for the organization, filterable by type and active state.

GET
/v1/contact-groups

Returns a paginated list of contact groups for the organization, filterable by type and active state.

x-api-key<token>

In: header

Query Parameters

page?string|null
limit?string|null
type?|array<>|null
isActive?string|null

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/contact-groups"
{  "items": [    {      "id": "string",      "organizationId": "string",      "name": "string",      "description": "string",      "type": "static",      "criteria": {},      "color": "clay",      "icon": "string",      "parentGroupId": "string",      "contactCount": 0,      "lastCalculatedAt": "string",      "isActive": true,      "createdAt": "string",      "updatedAt": "string"    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

Related