Skip to main content
GET
List groups

Authorizations

Authorization
string
header
required

API key for authentication

Query Parameters

limit
integer
default:20

The number of items to return.

Required range: 1 <= x <= 100
cursor
string

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Maximum string length: 512

Response

A paginated list of groups in the workspace. The data.items field contains the list of groups, and the data.pagination.nextLink field contains a link to the next page of results, if available.

Workspace owners and admins get every group in the workspace, including private groups they are not a member of. Other members only get the groups they have access to: their own private groups, the shared groups they are a member of, and the groups shared with everyone. Being able to see a group in this list does not grant access to its contents: the group members, custom fields and contacts endpoints still require access to that specific group.

data
object
required
Example:
deprecations
string[]
Example: