> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List user attributes



## OpenAPI

````yaml /api/openapi.yaml get /v1/user-attributes
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: AI
    description: AI-powered query generation
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Labels
    description: >
      Manage labels in an organization. Labels can be applied to documents and
      folders to help organize and categorize content.


      **Label types:**

      - **Basic labels**: Can be created and managed by any user

      - **Verified labels**: Indicate curated or officially sanctioned content.
      Admin-only.

      - **Homepage labels**: Appear on the organization homepage. Admin-only.
  - name: Folders
    description: Create and organize content folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/user-attributes:
    get:
      tags:
        - User attributes
      summary: List user attributes
      operationId: listUserAttributes
      responses:
        '200':
          description: List of user attribute definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >
                            The unique identifier of the user attribute. This
                            will be an empty string for system attributes.
                          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        name:
                          type: string
                          description: >-
                            The attribute reference name used in modeling and
                            API calls
                          example: region
                        label:
                          type: string
                          description: The human-readable display name for the attribute
                          example: Region
                        type:
                          type: string
                          enum:
                            - String
                            - Number
                          description: The data type of the attribute
                          example: String
                        multiple_values:
                          type: boolean
                          description: Whether the attribute accepts multiple values
                          example: false
                        default_value:
                          type: string
                          nullable: true
                          description: >-
                            The default value for the attribute if not specified
                            for a user
                          example: us-east
                        description:
                          type: string
                          nullable: true
                          description: Optional description of the attribute's purpose
                          example: User region for RLS
                        system:
                          type: boolean
                          description: >-
                            Whether this is a system-defined attribute (`true`)
                            or custom attribute (`false`)
                          example: false
              examples:
                success:
                  summary: Success response
                  value:
                    records:
                      - id: ''
                        name: omni_user_id
                        label: Omni User ID
                        type: String
                        multiple_values: false
                        default_value: null
                        description: null
                        system: true
                      - id: ''
                        name: omni_user_email
                        label: Omni User Email
                        type: String
                        multiple_values: false
                        default_value: null
                        description: null
                        system: true
                      - id: ''
                        name: omni_user_name
                        label: Omni User Name
                        type: String
                        multiple_values: false
                        default_value: null
                        description: null
                        system: true
                      - id: ''
                        name: omni_user_timezone
                        label: Omni User Timezone
                        type: String
                        multiple_values: false
                        default_value: null
                        description: null
                        system: true
                      - id: ''
                        name: omni_is_org_admin
                        label: Omni Is Org Admin
                        type: String
                        multiple_values: false
                        default_value: null
                        description: null
                        system: true
                      - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        name: region
                        label: Region
                        type: String
                        multiple_values: false
                        default_value: us-east
                        description: User region for RLS
                        system: false
                      - id: b2c3d4e5-f6a7-8901-bcde-f23456789012
                        name: access_level
                        label: Access Level
                        type: Number
                        multiple_values: false
                        default_value: '1'
                        description: Numeric access level for user permissions
                        system: false
                      - id: c3d4e5f6-a7b8-9012-cdef-234567890123
                        name: departments
                        label: Departments
                        type: String
                        multiple_values: true
                        default_value: null
                        description: User departments for data filtering
                        system: false
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Unauthorized
                message: Invalid or missing API key
        '403':
          description: Forbidden - User does not have required admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Forbidden
                message: User does not have permission to manage user attributes
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    MethodNotAllowed:
      description: Method Not Allowed - Invalid HTTP method for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#personal-access-tokens-pat).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````