> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ndi.nace.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# list_domains

> List every domain visible to the caller. Cost class: cacheable.

Returns the platform-owned domains (``generic`` and the curated verticals,
all published and selectable) and the calling tenant's own rows.



## OpenAPI

````yaml /openapi.json get /v1/domains
openapi: 3.1.0
info:
  description: >-
    Document intelligence: parse, split, classify, extract, and ground files, or
    build a searchable workspace. Authenticate with ``X-API-Key``.
  title: NDI Platform API
  version: 0.1.0
servers:
  - url: https://ndi-api.nace.ai
security: []
tags: []
paths:
  /v1/domains:
    get:
      tags:
        - domains
      summary: list_domains
      description: >-
        List every domain visible to the caller. Cost class: cacheable.


        Returns the platform-owned domains (``generic`` and the curated
        verticals,

        all published and selectable) and the calling tenant's own rows.
      operationId: list_domains_v1_domains_get
      parameters:
        - description: 'Filter by ownership: `platform` (standard) or `tenant` (yours).'
          in: query
          name: owner
          required: false
          schema:
            anyOf:
              - enum:
                  - platform
                  - tenant
                type: string
              - type: 'null'
            description: 'Filter by ownership: `platform` (standard) or `tenant` (yours).'
            title: Owner
        - description: Filter by lifecycle status.
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - enum:
                  - draft
                  - published
                type: string
              - type: 'null'
            description: Filter by lifecycle status.
            title: Status
        - description: >-
            Opaque cursor from a previous page's `next_cursor`. Omit for the
            first page.
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Opaque cursor from a previous page's `next_cursor`. Omit for the
              first page.
            title: Cursor
        - description: Rows per page.
          in: query
          name: limit
          required: false
          schema:
            default: 50
            description: Rows per page.
            maximum: 200
            minimum: 1
            title: Limit
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_DomainSummary_'
          description: Successful Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Gateway Timeout
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  detail: null
                  message: >-
                    Request body has extra fields that this operation does not
                    accept.
                  request_id: req-01j9k2n3p4q5r6s7t8v9
                  retryable: false
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: >-
            Typed error envelope used by every 4xx and 5xx. ``error.code``
            distinguishes the failure; HTTP status is a consequence of the code.
      security:
        - APIKeyHeader: []
components:
  schemas:
    Page_DomainSummary_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DomainSummary'
          title: Items
          type: array
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Opaque; null means the last page.
          title: Next Cursor
        total_count:
          description: Exact, and filtered by the caller's access predicate.
          title: Total Count
          type: integer
      required:
        - items
        - total_count
      title: Page[DomainSummary]
      type: object
    ErrorEnvelope:
      description: Every non-2xx body on ``/v1``.
      example:
        error:
          code: invalid_request
          detail: null
          message: Request body has extra fields that this operation does not accept.
          request_id: req-01j9k2n3p4q5r6s7t8v9
          retryable: false
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
      title: ErrorEnvelope
      type: object
    DomainSummary:
      additionalProperties: false
      description: A domain without its vocabularies, for listings.
      properties:
        class_count:
          title: Class Count
          type: integer
        display_name:
          title: Display Name
          type: string
        domain_id:
          format: uuid
          title: Domain Id
          type: string
        owner:
          enum:
            - platform
            - tenant
          title: Owner
          type: string
        parent_slug:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Inheritance lineage for platform domains that extend a base
            vocabulary.
          title: Parent Slug
        selectable:
          description: True once published; a workspace may only pin a published version.
          title: Selectable
          type: boolean
        slug:
          title: Slug
          type: string
        status:
          enum:
            - draft
            - published
          title: Status
          type: string
        version:
          title: Version
          type: integer
      required:
        - domain_id
        - slug
        - display_name
        - owner
        - version
        - status
        - class_count
        - selectable
      title: DomainSummary
      type: object
    Error:
      description: The error object, per spec 12 §1.8.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        detail:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Structured payload, when the code carries one.
          title: Detail
        message:
          description: Human- and model-readable; says what to do differently.
          title: Message
          type: string
        request_id:
          description: Per-request correlation id; matches the ``X-Request-Id`` header.
          title: Request Id
          type: string
        retryable:
          description: Whether retrying the identical request could succeed.
          title: Retryable
          type: boolean
      required:
        - code
        - message
        - retryable
        - request_id
      title: Error
      type: object
    ErrorCode:
      description: |-
        Every error the ``/v1`` surface can return.

        Clients must treat this as an **open** enum: a new member is an additive
        change (spec 12 §9), and a client that crashes on an unknown code makes
        every future error a breaking change.
      enum:
        - invalid_request
        - unsupported_file_type
        - file_too_large
        - invalid_schema
        - invalid_sql
        - invalid_path_prefix
        - command_not_permitted
        - batch_too_large
        - domain_validation_failed
        - default_label_required
        - wait_required_for_zero_retention
        - workspace_not_found
        - file_not_found
        - job_not_found
        - upload_not_found
        - node_not_found
        - schema_not_found
        - domain_not_found
        - session_not_found
        - access_label_not_found
        - path_conflict
        - schema_version_conflict
        - access_label_name_taken
        - workspace_name_taken
        - access_label_in_use
        - upload_expired
        - file_not_ingested
        - workspace_deleting
        - workspace_not_deletable
        - ingestion_in_progress
        - job_not_cancellable
        - confirmation_required
        - domain_not_published
        - domain_in_use
        - reserved_domain_slug
        - kg_not_built
        - kg_build_in_progress
        - session_busy
        - range_not_satisfiable
        - result_expired
        - access_denied
        - access_backstop_violation
        - access_mode_not_implemented
        - rate_limited
        - concurrency_limit_reached
        - quota_exceeded
        - corrupt_file
        - zero_byte_file
        - encrypted_file
        - parse_failed
        - ocr_failed
        - conversion_failed
        - sheetless_workbook
        - unplayable_media
        - unclassified_pages
        - job_cancelled
        - job_timeout
        - upstream_unavailable
        - internal_error
        - unauthorized
        - not_implemented
      title: ErrorCode
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````