List Groups

List every group in the workspace, including the built-in "All Users" group.

Each group carries its member ids and its user_attribute_precedence. A warning is returned when two groups in the workspace share a precedence value, since the winning user attribute is then undefined.

get

/workspaces/{workspace_id}/groups

Authorizations

AuthorizationstringRequired

A Personal Access Token (PAT).

Path parameters

workspace_idstringRequired

Responses

200

Successful Response

application/json

4XX

Client Error

application/json

5XX

Server Error

application/json

get/workspaces/{workspace_id}/groups

curl -L https://api-external.zenlytic.com/api/v2/workspaces/<workspace_id>/groups \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "data": [
    {
      "id": "grp_123",
      "workspace_id": "ws_456",
      "name": "Sales",
      "is_all_users": false,
      "user_attribute_precedence": 1,
      "users": [
        "usr_111",
        "usr_222"
      ]
    }
  ],
  "meta": {
    "status": "success",
    "errors": [],
    "warnings": []
  }
}