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

> Page through appetite cells (per market, business class, and line).



## OpenAPI

````yaml GET /api/v1/catalog/appetite
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/appetite:
    get:
      tags:
        - Catalog
      summary: List Catalog Appetite
      description: >
        Returns one page of current appetite cells (per market, business class,

        and line) for the authenticated organization's active data connection.

        Scoped credentials require `catalog:read`. Appetite is
        honesty-by-absence:

        a connection with no appetite data returns an empty page, not an error.
      operationId: listCatalogAppetite
      parameters:
        - $ref: '#/components/parameters/CatalogConnectionID'
        - $ref: '#/components/parameters/CatalogBusinessClass'
        - $ref: '#/components/parameters/CatalogState'
        - $ref: '#/components/parameters/CatalogLine'
        - $ref: '#/components/parameters/CatalogEligibility'
        - $ref: '#/components/parameters/CatalogPage'
        - $ref: '#/components/parameters/CatalogPageSize'
      responses:
        '200':
          description: One page of appetite cells.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogAppetiteListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/AuthUnavailable'
components:
  parameters:
    CatalogConnectionID:
      name: connection_id
      in: query
      description: >
        Pin the browse to one active data connection. Optional when the org has
        a

        single active connection; required when it has more than one (an
        ambiguous

        request returns `catalog_connection_ambiguous`).
      schema:
        type: string
        format: uuid
    CatalogBusinessClass:
      name: business_class
      in: query
      description: Exact appetite business-class label.
      schema:
        type: string
    CatalogState:
      name: state
      in: query
      description: >-
        Two-letter state code. Keeps products eligible in the state (not
        excluded).
      schema:
        type: string
        pattern: ^[A-Za-z]{2}$
    CatalogLine:
      name: line
      in: query
      description: >-
        Line-of-business filter matched against the product's `line` or
        `line_code`.
      schema:
        type: string
    CatalogEligibility:
      name: eligibility
      in: query
      description: >-
        Appetite eligibility value (`acceptable`, `will_consider`, or
        `not_a_market`).
      schema:
        type: string
    CatalogPage:
      name: page
      in: query
      description: 1-based page number. Defaults to 1.
      schema:
        type: integer
        minimum: 1
        default: 1
    CatalogPageSize:
      name: page_size
      in: query
      description: Rows per page, clamped to 100. Defaults to 25.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  schemas:
    CatalogAppetiteListResponse:
      type: object
      additionalProperties: false
      required:
        - items
        - page
        - page_size
        - total_matched
        - total_corpus
        - facets
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CatalogAppetiteCell'
        page:
          type: integer
        page_size:
          type: integer
        total_matched:
          type: integer
        total_corpus:
          type: integer
        facets:
          $ref: '#/components/schemas/CatalogFacets'
    CatalogAppetiteCell:
      type: object
      additionalProperties: false
      required:
        - market_entity_key
        - segment
        - business_class
        - line
        - line_code
        - eligibility
        - confidence
        - provenance
      properties:
        market_entity_key:
          type: string
        segment:
          type: string
        business_class:
          type: string
        line:
          type: string
        line_code:
          type: string
        eligibility:
          type: string
          description: One of `acceptable`, `will_consider`, `not_a_market`.
        confidence:
          type: number
          nullable: true
        signals:
          type: object
          description: Reserved derived-signal extension point; omitted until populated.
        provenance:
          $ref: '#/components/schemas/CatalogProvenance'
    CatalogFacets:
      type: object
      additionalProperties: false
      required:
        - lob
      properties:
        lob:
          type: array
          description: >-
            Distinct line labels over the full corpus (ignores filters), for the
            filter dropdown.
          items:
            type: string
    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_blob_ref
        - extraction_run_id
        - effective_from
      properties:
        source_blob_ref:
          type: string
          nullable: true
          description: Source document lineage reference. Null when no source was recorded.
        extraction_run_id:
          type: string
          format: uuid
          nullable: true
          description: The extraction run that produced this row. Null when unrecorded.
        effective_from:
          type: string
          format: date-time
          description: When this served head became current.
  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
    NotFound:
      description: The requested resource does not exist in the authenticated org.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: not_found
            message: Market not found
    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`, `runs:test`, and `converse:use`. Operation
        descriptions name the required capability.
        Grandfathered `nx_live_...` and `nx_test_...` keys retain their existing
        broad access during the compatibility window.

````