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

# List topics

> Retrieve a list of topics in the model, including composite topics.




## OpenAPI

````yaml /api/openapi.yaml get /v1/models/{modelId}/topic
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: 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/models/{modelId}/topic:
    get:
      tags:
        - Topics
      summary: List topics
      description: |
        Retrieve a list of topics in the model, including composite topics.
      operationId: modelsListTopics
      parameters:
        - $ref: '#/components/parameters/modelId'
        - $ref: '#/components/parameters/branchId'
      responses:
        '200':
          description: List of topics in the model
          content:
            application/json:
              schema:
                required:
                  - success
                  - topics
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the operation succeeded
                  topics:
                    type: array
                    description: List of topic objects
                    items:
                      anyOf:
                        - title: Regular topic
                          type: object
                          properties:
                            base_view_name:
                              $ref: '#/components/schemas/TopicBaseViewName'
                            description:
                              $ref: '#/components/schemas/TopicDescription'
                            group_label:
                              type: string
                              description: Group label
                            hidden:
                              $ref: '#/components/schemas/TopicHidden'
                            is_composite:
                              $ref: '#/components/schemas/TopicIsComposite'
                            label:
                              $ref: '#/components/schemas/TopicLabel'
                            name:
                              $ref: '#/components/schemas/TopicName'
                        - title: Composite topic
                          type: object
                          properties:
                            description:
                              $ref: '#/components/schemas/TopicDescription'
                            hidden:
                              $ref: '#/components/schemas/TopicHidden'
                            is_composite:
                              $ref: '#/components/schemas/TopicIsComposite'
                            label:
                              $ref: '#/components/schemas/TopicLabel'
                            name:
                              $ref: '#/components/schemas/TopicName'
                            import_models:
                              $ref: '#/components/schemas/CompositeTopicImportModels'
                            topics:
                              $ref: '#/components/schemas/CompositeTopicTopicList'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: Model not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
components:
  parameters:
    modelId:
      name: modelId
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174000
      required: true
      in: path
      description: The ID of the model.
    branchId:
      name: branch_id
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174001
      required: false
      description: Branch ID to use for branch-aware operations
      in: query
  schemas:
    TopicBaseViewName:
      name: base_view_name
      type: string
      description: Name of the topic's base view
      example: product_features
    TopicDescription:
      type: string
      description: Description of the topic, shown in the topic picker
      example: Details about the Blobs R Us product roadmap
    TopicHidden:
      type: boolean
      description: Whether the topic is hidden from the topic picker.
      example: false
    TopicIsComposite:
      name: is_composite
      type: boolean
      enum:
        - false
      description: >-
        Whether the topic is a composite topic. Absent or `false` for a regular
        topic; only present and `true` on a [composite
        topic](/modeling/composite-topics).
    TopicLabel:
      type: string
      description: The display label for the topic
      example: Blob Roadmap
    TopicName:
      type: string
      description: The name of the topic
      example: blob_roadmap
    CompositeTopicImportModels:
      name: import_models
      type: array
      description: Other models this composite topic imports topics from.
      items:
        type: object
        properties:
          model_ref:
            type: string
            description: The ID of the model the topics are imported from.
          topics:
            type: array
            description: The topics imported from the source model.
            items:
              type: object
              properties:
                topic:
                  type: string
                  description: The name of the topic in the source model.
                alias:
                  type: string
                  description: A local alias for the imported topic.
                ignored:
                  type: boolean
                  description: Whether the imported topic is ignored.
    CompositeTopicTopicList:
      name: topics
      type: array
      items:
        type: string
      description: >-
        The names of the two or more topics combined into this composite topic.
        See [topics](/modeling/composite-topics/parameters/topics).
    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
  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`

````