> ## 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 folder > Retrieve a single folder by its ID. Owner and permission information is returned separately by the [Get folder permissions](/api/folder-permissions/get-folder-permissions) endpoint. The calling user must have access to the specified folder or the API will return an error. ## OpenAPI ````yaml /api/openapi.yaml get /v1/folders/{folderId} 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: App downloads description: Download apps as PNG, PDF, XLSX, or CSV files - 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: IP Allowlist description: Manage the organization's IP allowlist - 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 favorites description: Favorite and unfavorite 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/folders/{folderId}: get: tags: - Folders summary: Get folder description: > Retrieve a single folder by its ID. Owner and permission information is returned separately by the [Get folder permissions](/api/folder-permissions/get-folder-permissions) endpoint. The calling user must have access to the specified folder or the API will return an error. operationId: getFolder parameters: - name: folderId in: path required: true schema: type: string format: uuid description: >- The UUID of the folder to retrieve. Use the [List folders](/api/folders/list-folders) endpoint to retrieve folder IDs. - $ref: '#/components/parameters/userId' responses: '200': description: The requested folder content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for the folder name: type: string description: Display name of the folder path: type: string description: Full path to the folder, including parent folders url: type: string description: URL to view the folder in Omni breadcrumbRoot: type: boolean description: Whether breadcrumbs for content in this folder start here labels: type: array items: type: string description: Labels applied to the folder required: - id - name - path - url - breadcrumbRoot - labels examples: success: summary: Folder found value: id: 3c90c3cc-0d44-4b50-8888-8dd25736052a name: Q1 Reports path: sales-reports/q1-reports url: https://{instance}.omniapp.co/f/sales-reports/q1-reports breadcrumbRoot: false labels: - finance '400': description: | Bad Request Possible error messages: - `folderId` is not a valid UUID - `userId` is not a valid UUID content: application/json: schema: $ref: '#/components/schemas/ApiError400' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/ApiError401' '403': description: | Forbidden Possible error messages: - A personal access token named a `userId` other than its own content: application/json: schema: $ref: '#/components/schemas/ApiError403' '404': description: > Not Found Possible error messages: - `Folder with id does not exist` - Also returned when the folder exists but the caller, or the user named by `userId`, cannot view it - `userId` does not match a member of the organization content: application/json: schema: $ref: '#/components/schemas/ApiError404' '429': $ref: '#/components/responses/TooManyRequests' security: - bearerAuth: [] components: parameters: userId: name: userId schema: type: string format: uuid required: false description: > **Organization API key required.** The membership ID of the user to act as. in: query schemas: 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 ApiError403: 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: 403 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 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#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.