---
title: "List all user attribute definitions"
method: GET
path: "/api/v1/user-attributes"
tags: ["User Attributes"]
---

# List all user attribute definitions

`GET /api/v1/user-attributes`

Returns all user attribute definitions in the organization, including system-defined attributes (e.g. omni_user_id, omni_user_email) and custom attributes.

## Response `200`

List of all user attribute definitions in the organization

- UserAttributesListResponse
  - `records` object[], required — All user attribute definitions in the organization, including both system-defined and custom attributes
    - `default_value` union, required — Default value applied when no user-specific value is set. When multiple_values is true, this is an array. Null if no default is configured.
      - string
      - number
      - union[]
        - union
          - string
          - number
    - `description` string, nullable, required — Human-readable description of the attribute and its purpose
    - `id` string, required — Unique identifier for custom attributes. Empty string for system-defined attributes.
    - `label` string, required — Display name shown in the Omni UI
    - `multiple_values` boolean, required — Whether the attribute accepts an array of values. When true, default_value and user-specific values are arrays.
    - `name` string, required — Reference name used in model SQL and in embed SSO URL parameters
    - `system` boolean, required — System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes have system=false.
    - `type` 'String' | 'Number', required — Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision.

## Other responses

- `401` — Authentication required
- `403` — Insufficient permissions

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/de7cac8b5983/schema)