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

# List catalog items

> Lists the workspace catalog items. Requires catalog:read; cost, currency and their state/basis are present only when the key also holds catalog.cost:read. Only verified cost matches the current unit; review_required and invalid must not be treated as an applicable price. Unpaged at pilot scale.



## OpenAPI

````yaml /openapi.en.json get /v1/catalog/items
openapi: 3.1.0
info:
  description: >-
    The Muveya public developer API: opaque-API-key-authenticated,
    tenant-scoped, read-only /v1 resources. One rate-limit budget per key.
  title: Muveya Developer API
  version: 0.1.0
servers:
  - description: Production
    url: https://api.muveya.com
security: []
tags:
  - name: API key
  - name: Clinics
  - name: Warehouses
  - name: Catalog
  - name: Inventory
  - name: Orders
  - name: Fulfillments
  - name: Analytics
paths:
  /v1/catalog/items:
    get:
      tags:
        - Catalog
      summary: List catalog items
      description: >-
        Lists the workspace catalog items. Requires catalog:read; cost, currency
        and their state/basis are present only when the key also holds
        catalog.cost:read. Only verified cost matches the current unit;
        review_required and invalid must not be treated as an applicable price.
        Unpaged at pilot scale.
      operationId: listCatalogItems
      parameters: []
      responses:
        '200':
          description: The requested page of resources.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                  - hasMore
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type: string
                    description: >-
                      Opaque keyset cursor for the next page; present only when
                      hasMore is true.
          headers:
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
        '401':
          description: >-
            The API key is missing, invalid, revoked, expired, or bound to a
            suspended workspace.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: The API key lacks the scope this route requires.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: The API key exceeded its rate limit for the current window.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Positive delta-seconds until another request is allowed.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    CatalogItem:
      type: object
      additionalProperties: false
      required:
        - itemId
        - sku
        - name
        - categoryId
        - unitOfMeasure
        - criticality
        - tracksLot
        - tracksSerial
        - tracksExpiry
        - highValue
        - status
      properties:
        itemId:
          type: string
        sku:
          type: string
        name:
          type: string
        description:
          type: string
        categoryId:
          type: string
        unitOfMeasure:
          type: string
          enum:
            - unit
            - box
            - pack
            - bottle
            - ampoule
            - milliliter
            - liter
            - gram
            - kilogram
            - pair
            - kit
        brand:
          type: string
        photoKeys:
          type: array
          items:
            type: string
        packaging:
          type: string
        criticality:
          type: string
          enum:
            - low
            - medium
            - high
        tracksLot:
          type: boolean
        tracksSerial:
          type: boolean
        tracksExpiry:
          type: boolean
        highValue:
          type: boolean
        status:
          type: string
          enum:
            - draft
            - active
            - inactive
        cost:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: >-
            Recorded cost in minor units. Interpret it with costStatus and
            costMeasurement; requires catalog.cost:read.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO-4217. Present only with catalog.cost:read.
        costStatus:
          type: string
          enum:
            - unset
            - verified
            - review_required
            - invalid
          description: >-
            Cost applicability and data quality. Omitted together with all cost
            metadata without catalog.cost:read.
        costMeasurement:
          type: object
          additionalProperties: false
          required:
            - unitOfMeasure
            - measurementVersion
            - quantityProtocol
          properties:
            unitOfMeasure:
              type: string
              enum:
                - unit
                - box
                - pack
                - bottle
                - ampoule
                - milliliter
                - liter
                - gram
                - kilogram
                - pair
                - kit
            measurementVersion:
              type: integer
              minimum: 1
              maximum: 9007199254740991
            quantityProtocol:
              type: string
              const: base_number_v1
      oneOf:
        - not:
            anyOf:
              - required:
                  - costStatus
              - required:
                  - cost
              - required:
                  - currency
              - required:
                  - costMeasurement
        - required:
            - costStatus
          properties:
            costStatus:
              const: unset
          not:
            anyOf:
              - required:
                  - cost
              - required:
                  - currency
              - required:
                  - costMeasurement
        - required:
            - costStatus
            - cost
            - currency
            - costMeasurement
          properties:
            costStatus:
              const: verified
        - required:
            - costStatus
            - cost
            - currency
          properties:
            costStatus:
              const: review_required
        - required:
            - costStatus
          properties:
            costStatus:
              const: invalid
          not:
            required:
              - costMeasurement
          oneOf:
            - required:
                - cost
                - currency
            - not:
                anyOf:
                  - required:
                      - cost
                  - required:
                      - currency
    ProblemDetails:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
        requestId:
          type: string
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one
        workspace server-side; the path never carries a workspace selector.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.