v1

latestOpenAPI 3.1.02026-07-1451089.2 KB

List contacts in a group

Retrieves all contacts in a given group for the entire team.

get/teams/{teamKey}/contacts/views/__default__/groups/{groupByKeyEncoded}

Path parameters

teamKeystring required

Team key

groupByKeyEncodedstring required

The groupByKeyEncoded value from the list of groups for contacts

Query parameters

cursorstring

If retrieving beyond the first page of results, this is the cursor returned by calls from the previous page

offsetinteger

When paginating using the limit parameter, this indicates the numeric offset to retrieve. Either this parameter or cursor should be specified.

limitinteger

Maximum number of boxes to return per page

Response

200

object required