> ## 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.

# Get custom color palette

> Retrieve a custom chart color palette by ID.




## OpenAPI

````yaml /api/openapi.yaml get /v1/color-palettes/{colorPaletteId}
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: 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/color-palettes/{colorPaletteId}:
    get:
      tags:
        - Color Palettes
      summary: Get custom color palette
      description: |
        Retrieve a custom chart color palette by ID.
      operationId: colorPalettesGet
      parameters:
        - $ref: '#/components/parameters/colorPaletteId'
      responses:
        '200':
          description: Color palette details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColorPaletteObject'
        '400':
          description: |
            Bad Request. The `id` parameter is not a valid UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
              example:
                detail: 'Bad Request: id: Invalid UUID'
                status: 400
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
              example:
                detail: 'Unauthorized: Missing or invalid API key'
                status: 401
        '404':
          description: >
            Not Found. No color palette with that ID exists in the caller's
            organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
              example:
                detail: >-
                  Color palette with id 00000000-0000-0000-0000-000000000000
                  does not exist
                status: 404
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    colorPaletteId:
      name: colorPaletteId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 3c90c3cc-0d44-4b50-8888-8dd25736052a
      description: Palette ID
  schemas:
    ColorPaletteObject:
      type: object
      properties:
        colors:
          $ref: '#/components/schemas/ColorPaletteColors'
        id:
          $ref: '#/components/schemas/ColorPaletteId'
        created_at:
          $ref: '#/components/schemas/ColorPaletteCreatedAt'
        name:
          $ref: '#/components/schemas/ColorPaletteName'
        type:
          $ref: '#/components/schemas/ColorPaletteType'
        updated_at:
          $ref: '#/components/schemas/ColorPaletteUpdatedAt'
      example:
        id: 3c90c3cc-0d44-4b50-8888-8dd25736052a
        name: Brand colors
        type: discrete
        colors:
          - '#1f77b4'
          - '#ff7f0e'
          - '#2ca02c'
        created_at: '2026-09-10T10:00:00.000Z'
        updated_at: '2026-09-10T10:00:00.000Z'
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    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
    ApiError404:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 404
      required:
        - detail
        - status
    ColorPaletteColors:
      type: array
      items:
        type: string
        pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
        example: '#1f77b4'
      minItems: 1
      maxItems: 50
      description: >-
        Ordered hex colors. Discrete palettes are used in order; continuous
        palettes interpolate between them.
      example:
        - '#1f77b4'
        - '#ff7f0e'
        - '#2ca02c'
    ColorPaletteId:
      type: string
      format: uuid
      description: Palette ID. Visualizations reference the palette by this value.
    ColorPaletteCreatedAt:
      type: string
      format: date-time
      description: When the palette was created
    ColorPaletteName:
      type: string
      minLength: 1
      maxLength: 256
      description: Palette name, unique per type within the organization
      example: Brand colors
    ColorPaletteType:
      type: string
      enum:
        - discrete
        - continuous
      description: |
        - `discrete` palettes color categories
        - `continuous` palettes define a gradient for numeric scales
      example: discrete
    ColorPaletteUpdatedAt:
      type: string
      format: date-time
      description: When the palette was last updated
    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'
  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`

````