v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
User attributes

List user attributes

<Note> **Organization Admin** permissions are required to use this endpoint. </Note>

Retrieve all user attribute definitions in your organization, including both custom-defined and system-defined attributes.

User attributes enable row-level security filtering, personalize dashboard content, and configure per-user database credentials. This endpoint is useful for embed integrations to discover available attributes for setting values in SSO sessions.

get/v1/user-attributes

Response

List of user attribute definitions

Example response

{
  "records": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "region",
      "label": "Region",
      "type": "String",
      "default_value": "us-east",
      "description": "User region for RLS"
    }
  ]
}