Skip to main content

ListGroups lists contact groups for the organization.

GET 
/api/v1/engagements/contacts/groups

Returns all groups available for contact segmentation.

Pagination​

  • page: Page number (default: 1)
  • per_page: Results per page (default: 20, max: 100)

Filtering​

  • search: Filter by group name (partial match)

Response​

Returns paginated list of groups sorted by name.

Errors​

  • PERMISSION_DENIED: Caller lacks contacts:read permission

Request​

Responses​

A successful response.