> ## 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 switchable attributes for the current user

> Retrieve the [user attributes](/administration/users/attributes/user-selected) the calling user can switch, along with any switch that is currently active.

If the calling user is using a PAT, the token will act as the authenticating user. An Organization API key will act as the key's creator.




## OpenAPI

````yaml /api/openapi.yaml get /v1/user-attribute-selections
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: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - 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: Color Palettes
    description: Manage custom chart color palettes
  - 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: 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: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder labels
    description: Apply and manage labels on 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: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - 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-attribute-selections:
    get:
      tags:
        - User attributes
      summary: List switchable attributes for the current user
      description: >
        Retrieve the [user
        attributes](/administration/users/attributes/user-selected) the calling
        user can switch, along with any switch that is currently active.


        If the calling user is using a PAT, the token will act as the
        authenticating user. An Organization API key will act as the key's
        creator.
      operationId: userAttributeSelectionsList
      responses:
        '200':
          description: >
            The caller's switchable attributes and active switches.


            If nothing is provisioned for the calling user, the `records` in the
            response will be empty.


            An **Organization Admin** will get a record for every attribute with
            `allow_any_value: true`, whether or not anything is provisioned for
            them.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAttributeSelectionsResponse'
              examples:
                success:
                  summary: One switchable attribute, no active switch
                  value:
                    records:
                      - user_attribute_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        name: client
                        label: Client
                        multiple_values: false
                        allow_any_value: false
                        selectable_values:
                          - acme
                          - globex
                          - initech
                        selected_values: null
                empty:
                  summary: Nothing provisioned for the caller
                  value:
                    records: []
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
              example:
                detail: 'Unauthorized: Missing or invalid API key'
                status: 401
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    UserAttributeSelectionsResponse:
      type: object
      required:
        - records
      properties:
        records:
          type: array
          description: >
            Attributes the calling user can switch. Empty when nothing is
            provisioned for them. An Organization Admin receives every attribute
            with `allow_any_value: true`.
          items:
            type: object
            required:
              - allow_any_value
              - label
              - multiple_values
              - name
              - selectable_values
              - selected_values
              - user_attribute_id
            properties:
              user_attribute_id:
                $ref: '#/components/schemas/UserAttributeId'
                description: The user attribute definition ID.
              name:
                $ref: '#/components/schemas/UserAttributeName'
              label:
                $ref: '#/components/schemas/UserAttributeLabel'
                description: Display name shown in the Omni UI.
              multiple_values:
                $ref: '#/components/schemas/UserAttributeMultipleValues'
              allow_any_value:
                $ref: '#/components/schemas/UserAttributeAllowAnyValue'
              selectable_values:
                $ref: '#/components/schemas/UserAttributeSelectableValues'
              selected_values:
                $ref: '#/components/schemas/UserAttributeSelectedValues'
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    UserAttributeId:
      type: string
      description: >-
        Unique identifier for custom attributes. Empty string for system-defined
        attributes.
      example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
    UserAttributeName:
      type: string
      minLength: 1
      description: >
        Reference name used in model SQL and in embed SSO URL parameters. Unique
        within the organization. Must start with a letter, contain only letters,
        numbers and underscores, and must not start with `omni_`.
      example: region
    UserAttributeLabel:
      type: string
      minLength: 1
      description: >
        Display name shown in the Omni UI. Unique among the custom attributes in
        the organization, and may match the label of a system attribute. 


        Must not start with `Omni` and must not be one of the reserved
        connection labels: `Host`, `Password`, `Database`, `Port`, `Schema`,
        `Connection Name`.
      example: Region
    UserAttributeMultipleValues:
      type: boolean
      default: false
      description: Whether the attribute accepts an array of values.
      example: false
    UserAttributeAllowAnyValue:
      type: boolean
      description: >-
        Whether the user or group can switch to a value that is not listed. When
        `true`, `selectable_values` are suggestions.
      example: false
    UserAttributeSelectableValues:
      type: array
      items:
        type: string
      description: >
        The provisioned values. When `allow_any_value` is `true`, up to 200
        suggestions drawn from values assigned to users in the organization.
      example:
        - acme
        - globex
    UserAttributeSelectedValues:
      type: array
      items:
        type: string
      description: The active switch, or `null` when the assigned value applies.
      example:
        - globex
    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#token-types).


        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`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.