v4

latestOpenAPI 3.1.0Proprietary2026-08-01113851.0 KB
Groups

List workspace groups

Returns the groups shown in the Workspace Groups UI across the authenticated Account.

Example request:

GET /v1/groups?workspaceId=workspace123&limit=2

get/groups

Query parameters

workspaceIdstring

Restrict results to a workspace owned by the authenticated Account.

limitinteger

Maximum number of records to return.

cursorstring

Opaque pagination cursor returned by the previous response.

Response

Group list.

Example response

{
  "data": [
    {
      "id": "group123",
      "workspaceId": "workspace123",
      "name": "Engineering",
      "type": "custom"
    }
  ]
}