> ## 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.
# Retrieve an API token
>
This endpoint requires **Organization Admin** permissions.
description: Token id. Must be a valid UUID — malformed values return `400`.
## OpenAPI
````yaml /api/openapi.yaml get /v1/api-keys/{id}
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/api-keys/{id}:
get:
tags:
- API Tokens
summary: Retrieve an API token
description: |
This endpoint requires **Organization Admin** permissions.
description: Token id. Must be a valid UUID — malformed values return `400`.
responses:
'200':
description: Token found successfully.
content:
application/json:
schema:
type: object
required:
- id
- name
- type
- enabled
- createdAt
- membershipId
properties:
id:
type: string
format: uuid
description: The token's unique identifier.
name:
type: string
description: >-
The name given when the token was created. Not unique
within an organization.
type:
type: string
enum:
- organization
- personal
- mcp
description: |
Token type:
- `organization` - Organization API key
- `personal` - Personal Access Token (PAT)
- `mcp` - MCP OAuth PAT
enabled:
type: boolean
description: >-
Whether the token can currently authenticate. Organization
Admins can disable any token type; disabled tokens remain
visible but cannot authenticate.
createdAt:
type: string
format: date-time
description: ISO 8601 timestamp of when the token was created (UTC).
membershipId:
type: string
format: uuid
nullable: true
description: >-
The user membership the token is scoped to. `null` if
`type` is `organization`.
example:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
name: CI deployment key
type: organization
enabled: true
createdAt: '2026-04-20T10:00:00.000Z'
membershipId: null
'400':
description: >
Bad Request. The ID parameter is not a valid UUID, or the
Authorization header is malformed.
Possible error messages:
- `Bad Request: id: Invalid UUID`
- `Bad authorization header, must be formatted as Bearer `
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: 'Bad Request: id: Invalid UUID'
status: 400
'401':
description: |
Unauthorized. The Authorization header is missing.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
example:
error:
code: 400
message: >-
Bad authorization header, must be formatted as Bearer
'403':
description: >
Forbidden. Authentication succeeded but the caller is not an
organization admin, or the bearer token is invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
example:
error:
code: 403
message: Invalid bearer token
'404':
description: >
Not Found. No token with that ID exists in the caller's
organization.
The same `404` response is returned regardless of whether the token
exists in a different organization - no tenant information is
leaked.
Example error message:
- `Api key with id 00000000-0000-0000-0000-000000000000 does not
exist`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: >-
Api key with id 00000000-0000-0000-0000-000000000000 does not
exist
status: 404
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
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#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`
````