List Attribute Definitions

List the user attribute definitions in the workspace.

A definition declares the name, label, and data_type of an attribute. The per-user and per-group endpoints then assign values against these definitions.

get

/workspaces/{workspace_id}/user_attribute_definitions

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}/user_attribute_definitions

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

{
  "data": [
    {
      "id": "uad_123",
      "workspace_id": "ws_456",
      "name": "region",
      "data_type": "string",
      "label": "Region"
    }
  ],
  "meta": {
    "status": "success",
    "errors": [],
    "warnings": []
  }
}