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

# List Catalog Products

> Page through current products extracted across your active materialize connections.



## OpenAPI

````yaml GET /api/v1/catalog/products
openapi: 3.1.0
info:
  title: Nexio API
  version: '1.0'
  description: |
    Nexio agentic infrastructure API. Configure engines for placement,
    entity analysis, and other patterns. Submit runs, poll for results,
    or subscribe to signed webhook callbacks.
  contact:
    email: support@usenexio.com
    url: https://docs.usenexio.com
servers:
  - url: https://api.usenexio.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: EngineManagement
    description: Create, configure, and manage inference engines.
  - name: Engines
    description: Engine-scoped endpoints for submitting runs and retrieving results.
  - name: Runs
    description: Retrieve and reconcile submitted runs.
  - name: Catalog
    description: >-
      Read current carriers and products extracted for the authenticated
      organization.
  - name: Environments
    description: Isolated tenancy scopes under your org (one live plus non-live sandboxes).
  - name: Webhooks
    description: Manage webhook endpoints for push-based delivery of terminal run events.
paths:
  /api/v1/catalog/products:
    get:
      tags:
        - Catalog
      summary: List Catalog Products
      description: |
        Returns current served product heads across the authenticated
        organization's active materialize connections. Scoped credentials
        require `catalog:read`.

        Results use cursor pagination ordered by `product_key`, then `id`.
        Keep filters unchanged while following `next_cursor`.
      operationId: listCatalogProducts
      parameters:
        - $ref: '#/components/parameters/CatalogLimit'
        - $ref: '#/components/parameters/CatalogCursor'
        - $ref: '#/components/parameters/CatalogConnectionID'
        - $ref: '#/components/parameters/CatalogLOB'
        - $ref: '#/components/parameters/CatalogState'
        - $ref: '#/components/parameters/CatalogCarrierKey'
      responses:
        '200':
          description: One page of current product heads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogProductListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/AuthUnavailable'
components:
  parameters:
    CatalogLimit:
      name: limit
      in: query
      description: Maximum rows to return. Defaults to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    CatalogCursor:
      name: cursor
      in: query
      description: Opaque continuation cursor from the prior response.
      schema:
        type: string
    CatalogConnectionID:
      name: connection_id
      in: query
      description: Restrict the catalog to one active materialize connection.
      schema:
        type: string
        format: uuid
    CatalogLOB:
      name: lob
      in: query
      description: Exact line-of-business label.
      schema:
        type: string
    CatalogState:
      name: state
      in: query
      description: Two-letter state code matched against explicit product eligibility.
      schema:
        type: string
        pattern: ^[A-Za-z]{2}$
    CatalogCarrierKey:
      name: carrier_key
      in: query
      description: Exact stable carrier entity key.
      schema:
        type: string
  schemas:
    CatalogProductListResponse:
      type: object
      additionalProperties: false
      required:
        - products
        - next_cursor
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/CatalogProduct'
        next_cursor:
          type: string
          nullable: true
          description: Opaque continuation cursor. Null when the walk is exhausted.
    CatalogProduct:
      type: object
      additionalProperties: false
      required:
        - id
        - connection_id
        - product_key
        - carrier_key
        - carrier_id
        - carrier_name
        - lob
        - lob_code
        - line_class
        - product_name
        - product_code
        - commission_new
        - commission_renewal
        - commission_is_percent
        - appetite_strength
        - appetite_notes
        - underwriting_notes
        - eligible_states
        - state_scope
        - excluded_states
        - provenance
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
        product_key:
          type: string
        carrier_key:
          type: string
        carrier_id:
          type: string
        carrier_name:
          type: string
          nullable: true
        lob:
          type: string
        lob_code:
          type: string
          nullable: true
        line_class:
          type: string
        product_name:
          type: string
          nullable: true
        product_code:
          type: string
          nullable: true
        commission_new:
          type: number
          nullable: true
        commission_renewal:
          type: number
          nullable: true
        commission_is_percent:
          type: boolean
          nullable: true
        appetite_strength:
          type: string
          nullable: true
        appetite_notes:
          type: string
          nullable: true
        underwriting_notes:
          type: string
          nullable: true
        eligible_states:
          type: array
          items:
            type: string
        state_scope:
          type: string
          nullable: true
        excluded_states:
          type: array
          items:
            type: string
        provenance:
          $ref: '#/components/schemas/CatalogProvenance'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: |
            Stable snake_case error identifier. Safe to match programmatically.

            Known codes: `invalid_request`, `invalid_input`, `unauthorized`,
            `auth_unavailable`, `rate_limited`, `missing_run_id`,
            `invalid_run_id`, `run_not_found`, `invalid_offerings`,
            `missing_input`, `queue_unreachable`,
            `engine_not_found`, `engine_slug_conflict`, `engine_archived`,
            `invalid_engine_type`, `validation_error`,
            `webhook_not_found`, `webhook_limit_exceeded`, `invalid_url`,
            `invalid_events`, `invalid_description`, `invalid_auth_token`,
            `missing_endpoint_id`, `invalid_endpoint_id`, `missing_delivery_id`,
            `invalid_delivery_id`, `delivery_not_found`,
            `delivery_not_resendable`, `insufficient_capability`,
            `engine_version_required`, `engine_version_exact_required`,
            `engine_version_not_found`, `engine_version_invalid_format`,
            `engine_version_draft_requires_sandbox_key`,
            `engine_version_none_released`, `test_scenario_sandbox_only`,
            `test_scenario_forbidden`, `test_scenario_exact_version_required`,
            `test_scenario_version_not_supported`, `invalid_test_scenario`,
            `request_bound_exceeded`, and `run_cap_exceeded`.
        message:
          type: string
          description: Human-readable error message. May change between versions.
        details:
          description: |
            Optional request-specific details. Request-bound failures use the
            `RequestBoundDetails` object. Validation failures may use an array
            of field issues or another documented object.
    CatalogProvenance:
      type: object
      additionalProperties: false
      required:
        - source_document_ref
        - effective_year
        - has_pending_review
      properties:
        source_document_ref:
          type: string
          nullable: true
          description: Source document lineage reference. Null when no source was recorded.
        effective_year:
          type: integer
          nullable: true
          description: Effective year stated by the source. Null when absent.
        has_pending_review:
          type: boolean
          description: True when this exact served row has a pending human review flag.
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            invalidRequest:
              summary: Malformed JSON
              value:
                code: invalid_request
                message: Request body is not valid JSON
            invalidInput:
              summary: Input validation failed
              value:
                code: invalid_input
                message: Input failed validation
                details:
                  - field: input.address.state
                    message: address.state is required for placement runs.
            invalidOfferings:
              summary: Placement run missing offerings
              value:
                code: invalid_offerings
                message: Inline offerings failed validation
                details:
                  - field: offerings
                    message: >-
                      Offerings are required for placement runs. Pass provider
                      offerings in the top-level offerings array.
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unauthorized
            message: Missing or invalid API key
    Forbidden:
      description: Scoped key does not have the capability required by this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: insufficient_capability
            message: API key does not have permission for this action
    RateLimited:
      description: Rate limit exceeded. Retry after the window resets.
      headers:
        Retry-After:
          description: Seconds until the rate limit window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rate_limited
            message: Rate limit exceeded
    AuthUnavailable:
      description: API key authentication is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: auth_unavailable
            message: API key authentication is temporarily unavailable
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Send the credential as `Authorization: Bearer <key>`.

        Scoped partner credentials use the exclusive `nxsk_v1_...` namespace.
        Each scoped key is bound at issuance to one organization, one canonical
        named environment, an explicit engine set, and a least-privilege
        capability set. A malformed, unknown, rotated, or revoked `nxsk_` key
        fails closed and is never retried as a legacy key.

        Capabilities used by this API are `runs:write`, `runs:read`,
        `engines:read`, `catalog:read`, `webhooks:manage`,
        `runs:defensibility:read`, and `runs:test`. Operation descriptions name
        the required capability.
        Grandfathered `nx_live_...` and `nx_test_...` keys retain their existing
        broad access during the compatibility window.

````