List workspace groups

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns every group in a workspace, oldest first, with how many members each has. The list isn't paginated.

Every member of a group gets the group's role, and a member of several groups gets the highest of their roles. A group whose role is no_access blocks members who get their role only from it. An idp group grants its role only while the workspace uses identity-provider groups. Otherwise its role is stored but grants nothing.

This is limited to 120 requests per minute, shared with List group members. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner, admin, or editor of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused even though this endpoint only reads, and workspace API keys aren't accepted.</Note>

get/api/workspace/groups

Query parameters

workspaceIdstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Response

The workspace's groups.

Example response

{
  "groups": [
    {
      "description": "Product designers",
      "id": "68b4e1d2c9a7f3001e2d4b61",
      "member_count": 12,
      "name": "Design team",
      "role": "editor",
      "source": "custom",
      "unresolved_count": 0
    }
  ]
}

Changes

Changed in 1 of the 38 revisions of this API.1