v1

latestOpenAPI 3.0.02026-08-041326126.6 KB
Endpoints
Groups

Read Group

Get information about a group.

get/api/v1/groups/{id}

Path parameters

idinteger required

The ID of the group to query.

Query parameters

after_checkpointstring

Use with the output of the 'checkpoint' field to iteratively retrieve all members of the group where the total exceeds the query limit.

limitinteger

The maximum number of group members to return per page.

Response

Request was successfully processed

checkpointstring required

A token that can be used to get more group members.

additional_resultsboolean required

True if there are more group members to retrieve.