> ## 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/uploads/list-uploads",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# List uploads
> List all uploads ([CSV files and spreadsheets](/analyze-explore/data-input-csvs)) in the organization with metadata and optional filtering.
This endpoint requires **Organization Admin** permissions.
## OpenAPI
````yaml /api/openapi.yaml get /v1/uploads
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/uploads:
get:
tags:
- Uploads
summary: List uploads
description: >
List all uploads ([CSV files and
spreadsheets](/analyze-explore/data-input-csvs)) in the organization
with metadata and optional filtering.
This endpoint requires **Organization Admin** permissions.
operationId: listUploads
parameters:
- name: type
in: query
schema:
type: string
enum:
- csv
- spreadsheet
default: csv
description: Filter by upload type.
- name: connectionId
in: query
schema:
type: string
format: uuid
description: Filter by connection ID.
- name: modelId
in: query
schema:
type: string
format: uuid
description: >-
Filter by model ID. Shared models return non-private connection
uploads; workbook models return their own uploads.
- name: searchTerm
in: query
schema:
type: string
description: Search term to filter by file name (case-insensitive).
- name: pageSize
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: Number of items to return.
- name: cursor
in: query
schema:
type: string
description: Cursor for pagination (from previous response).
- name: sortField
in: query
schema:
type: string
enum:
- createdAt
- fileName
- updatedAt
default: updatedAt
description: Field to sort by.
- name: sortDirection
in: query
schema:
type: string
enum:
- asc
- desc
default: desc
description: Sort direction.
responses:
'200':
description: Uploads 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 upload.
file_name:
type: string
description: Original file name.
view_name:
type: string
description: View name in the model.
connection_id:
type: string
format: uuid
description: ID of the connection associated with the upload.
in_db_as_table_name:
type: string
nullable: true
description: >
**Requires that the connection have a defined table
upload schema.** The name of the database table
associated with the upload.
model_id:
type: string
format: uuid
nullable: true
description: >-
ID of the model the upload is associated with.
Inferred from connection's shared model if not
explicitly set via query parameter.
size_bytes:
type: integer
nullable: true
description: File size in bytes.
created_at:
type: string
format: date-time
description: ISO 8601 timestamp of when the upload was created.
updated_at:
type: string
format: date-time
description: >-
ISO 8601 timestamp of when the upload was last
updated.
uploaded_by_user:
type: object
nullable: true
description: User who uploaded the file. null if unknown.
properties:
id:
type: string
format: uuid
description: Membership ID.
name:
type: string
description: User display name.
example:
pageInfo:
hasNextPage: false
nextCursor: null
pageSize: 20
totalRecords: 2
records:
- id: 550e8400-e29b-41d4-a716-446655440000
file_name: users.csv
view_name: users
connection_id: 660e8400-e29b-41d4-a716-446655440001
in_db_as_table_name: omni_upload_t550e8400
model_id: 880e8400-e29b-41d4-a716-446655440003
size_bytes: 1024
created_at: '2025-01-15T10:00:00Z'
updated_at: '2025-01-15T10:00:00Z'
uploaded_by_user:
id: 770e8400-e29b-41d4-a716-446655440002
name: John Doe
'400':
description: |
Bad Request. Possible error messages include:
- `connectionId: Invalid uuid`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: 'Bad Request: connectionId: Invalid uuid'
status: 400
'401':
description: Missing or invalid authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Insufficient permissions. Requires `MANAGE_UPLOADS` permission.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: You do not have permission to perform this action
status: 403
'404':
description: Model not found (invalid `modelId`).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'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:
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`
````