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

# Search dashboards and apps

> Free-text search over the organization's dashboards and apps. Apps are included only if they are enabled for the organization.




## OpenAPI

````yaml /api/openapi.yaml get /v1/content/search
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: Embed
    description: Manage embed sessions
  - 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/content/search:
    get:
      tags:
        - Content
      summary: Search dashboards and apps
      description: >
        Free-text search over the organization's dashboards and apps. Apps are
        included only if they are enabled for the organization.
      operationId: contentSearch
      parameters:
        - name: limit
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 25
            default: 10
            example: 10
          required: false
          description: Max results to return (1-25).
          in: query
        - name: q
          schema:
            type: string
            minLength: 1
            description: >-
              Free-text keywords matched against names, descriptions, query
              names, folder names, labels, and creator names.
            example: revenue by region
          required: true
          description: >-
            Free-text keywords matched against names, descriptions, query names,
            folder names, labels, and creator names.
          in: query
        - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Matching dashboards and apps
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                          nullable: true
                          description: Description, if any.
                          example: Quarterly revenue breakdown across all regions
                        folderPath:
                          type: string
                          nullable: true
                          description: Folder path, if any.
                          example: /Finance/Reports
                        identifier:
                          type: string
                          description: >-
                            The document identifier, usable with the documents
                            endpoints. The schedules endpoints accept dashboard
                            results only.
                          example: 12db1a0a
                        name:
                          type: string
                          description: Dashboard or app name.
                          example: Revenue by region
                        tileNames:
                          type: array
                          items:
                            type: string
                          description: >-
                            Up to 5 query names from the document's workbook —
                            the first few, not the ones that matched. For an
                            app, the saved queries it can run.
                          example:
                            - Revenue Trend
                            - Regional Breakdown
                            - YoY Comparison
                        type:
                          type: string
                          enum:
                            - app
                            - dashboard
                          description: >
                            Whether the match opens as a dashboard or as an app.
                            Apps are returned only when the organization has
                            apps enabled.


                            If this field is absent, treat the result as a
                            dashboard.
                          example: dashboard
                        url:
                          type: string
                          description: >
                            URL to open the match as the surface its type names
                            (the published dashboard or app), with a redirect
                            query param matching the type: 


                            - `?redirectToDashboard=true` for dashboards

                            - `?redirectToApp=true` for apps


                            Omitted on MCP requests when the the organization
                            has the `disable-ai-mcp-links` feature flag enabled.
                          example: >-
                            https://blobsrus.omniapp.co/dashboards/12db1a0a?redirectToDashboard=true
                        verified:
                          type: boolean
                          description: Whether it carries a verified label.
                          example: true
                      required:
                        - description
                        - folderPath
                        - identifier
                        - name
                        - tileNames
                        - verified
                    description: Matching dashboards and apps, most relevant first.
                required:
                  - results
        '400':
          description: |
            Bad Request

            Possible error messages:
            - `q is required`
            - `limit must be between 1 and 25`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    userId:
      name: userId
      schema:
        type: string
        format: uuid
      required: false
      description: |
        **Organization API key required.** Target user membership ID.
      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
    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:
    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`

````