> ## 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.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/api-tokens/list-api-tokens",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# List API tokens
>
This endpoint requires **Organization Admin** permissions.
List API token in the organization - including Organization API keys, Personal Access Tokens, and MCP OAuth grants - with optional filtering by type. Only metadata - not actual secret values - are returned.
## OpenAPI
````yaml /api/openapi.yaml get /v1/api-keys
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:
get:
tags:
- API Tokens
summary: List API tokens
description: >
This endpoint requires **Organization Admin** permissions.
List API token in the organization - including Organization API keys,
Personal Access Tokens, and MCP OAuth grants - with optional filtering
by type. Only metadata - not actual secret values - are returned.
operationId: listApiKeys
parameters:
- name: type
in: query
schema:
type: string
enum:
- organization
- personal
- mcp
description: >
Filter by token type. Omit to return all types.
- `organization` - Organization-level API key. Not tied to a
specific user.
- `personal` - Personal access token. Acts as a specific user.
- `mcp` - MCP OAuth grant issued during the OAuth authorization flow
- name: cursor
in: query
schema:
type: string
format: uuid
description: Cursor for pagination.
- name: pageSize
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: Number of items to return per page.
- name: sortField
in: query
schema:
type: string
enum:
- createdAt
- name
default: createdAt
description: Field to sort by.
- name: sortDirection
in: query
schema:
type: string
enum:
- asc
- desc
default: desc
description: Sort direction.
responses:
'200':
description: API tokens retrieved successfully.
content:
application/json:
schema:
type: object
properties:
pageInfo:
$ref: '#/components/schemas/PageInfo'
records:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Unique ID for the token.
name:
type: string
description: Token name.
type:
type: string
enum:
- organization
- personal
- mcp
description: Token type.
enabled:
type: boolean
description: >-
Whether the token is enabled. `false` for disabled
Organization API keys; PATs and MCP tokens are
always `true`.
createdAt:
type: string
format: date-time
description: ISO 8601 timestamp of when the token was created.
membershipId:
type: string
format: uuid
nullable: true
description: >-
Membership ID of the user who owns the token. `null`
for Organization API keys.
example:
pageInfo:
hasNextPage: false
nextCursor: null
pageSize: 50
totalRecords: 2
records:
- id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
name: CI deployment key
type: organization
enabled: true
createdAt: '2026-01-15T10:00:00.000Z'
membershipId: null
- id: b2c3d4e5-f6a7-8901-bcde-f12345678901
name: Personal token
type: personal
enabled: true
createdAt: '2026-02-10T14:30:00.000Z'
membershipId: c3d4e5f6-a7b8-9012-cdef-123456789012
'400':
description: >
Bad Request. Validation errors include:
- `type: Invalid option: expected one of
"organization"|"personal"|"mcp"`
- `cursor: Invalid UUID`
- `pageSize: Page size must be at least 1`
- `pageSize: Page size cannot exceed 100`
- `pageSize: Invalid input: expected number, received NaN`
- `sortField: Invalid option: expected one of "createdAt"|"name"`
- `sortDirection: Invalid option: expected one of "asc"|"desc"`
- `Bad authorization header, must be formatted as Bearer `
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: >-
Bad Request: type: Invalid option: expected one of
"organization"|"personal"|"mcp"
status: 400
'403':
description: |
Forbidden. Requires Organization Admin permissions.
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
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
schemas:
PageInfo:
type: object
description: Pagination information for paginated responses.
properties:
hasNextPage:
type: boolean
description: Indicates if there are more records available.
nextCursor:
type: string
nullable: true
description: Cursor for the next page of results. `null` if no more results.
pageSize:
type: integer
description: Number of records per page.
totalRecords:
type: integer
description: Total number of records matching the query.
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`
````