List groups
/v1/groups in the Groups API.
curl https://api.example.test/v1/groups \ -H "Authorization: Bearer $TOKEN"Every group across the teams the caller sees. Rows carry neither permissions nor member_ids; read a group individually for those. Not paginated.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Responses
200OKapplication/json
Array of GroupResource
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on
Groups API
A group is a named bundle of permissions on a team that several members hold at once: put the three people who run the on-call rota into an incident-commanders group and they share its permissions, take one out and they keep only what their own role gives them.
Create a group
/v1/groups in the Groups API.