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

# List items



## OpenAPI

````yaml /technical-reference/openapi.yaml get /api/v1/items
openapi: 3.1.0
info:
  title: adorabl Public API
  version: 1.0.0
  description: >
    Partner REST API. Authenticate with OAuth 2.0 client credentials issued from

    Data & Admin → API clients. Tokens are bound to one adorabl organization.


    Successful resource responses always wrap the payload in `data` — a single

    object for get-by-id, an array plus `nextCursor` for list. Child collections

    such as `addresses`, `contacts`, `uomConversions`, and `lines` are always
    present

    (`[]` when empty). Optional scalars and singular refs (`terms`,

    `customerGroup`, `supplierGroup`, `paymentMethod`, `category`,

    `preferredSupplier`, `baseUom`, `customer`, `warehouse`, `shipTo`, `billTo`)

    are `null` (or a string for supplier terms), never omitted. Do not send

    empty objects (`{}`) for a missing child.
servers:
  - url: https://sherpa-topaz.vercel.app
security: []
paths:
  /api/v1/items:
    get:
      summary: List items
      operationId: listItems
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: cursor
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Item page
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Item'
                  nextCursor:
                    type:
                      - string
                      - 'null'
        '401':
          description: Missing or invalid token
        '403':
          description: Missing items:read scope
      security:
        - bearerAuth: []
components:
  schemas:
    Item:
      type: object
      required:
        - id
        - sku
        - name
        - description
        - itemType
        - salesPrice
        - costingMethod
        - standardCost
        - active
        - minOrderQty
        - maxOrderQty
        - leadTimeDays
        - externalId
        - createdAt
        - updatedAt
        - category
        - preferredSupplier
        - baseUom
        - purchaseUom
        - salesUom
        - uomConversions
      properties:
        id:
          type: string
          format: uuid
        sku:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        itemType:
          type: string
        salesPrice:
          type:
            - number
            - 'null'
        costingMethod:
          type: string
        standardCost:
          type:
            - number
            - 'null'
        active:
          type: boolean
        minOrderQty:
          type:
            - number
            - 'null'
        maxOrderQty:
          type:
            - number
            - 'null'
        leadTimeDays:
          type:
            - number
            - 'null'
        externalId:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        category:
          oneOf:
            - $ref: '#/components/schemas/ItemCategory'
            - type: 'null'
        preferredSupplier:
          oneOf:
            - $ref: '#/components/schemas/ItemPreferredSupplier'
            - type: 'null'
        baseUom:
          oneOf:
            - $ref: '#/components/schemas/ItemUom'
            - type: 'null'
        purchaseUom:
          oneOf:
            - $ref: '#/components/schemas/ItemUom'
            - type: 'null'
        salesUom:
          oneOf:
            - $ref: '#/components/schemas/ItemUom'
            - type: 'null'
        uomConversions:
          type: array
          description: Always present. Empty when the item has no alternate units.
          items:
            $ref: '#/components/schemas/ItemUomConversion'
    ItemCategory:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    ItemPreferredSupplier:
      type: object
      required:
        - id
        - supplierNumber
        - name
      properties:
        id:
          type: string
          format: uuid
        supplierNumber:
          type: string
        name:
          type: string
    ItemUom:
      type: object
      required:
        - id
        - code
        - name
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        name:
          type: string
    ItemUomConversion:
      type: object
      required:
        - id
        - conversionFactor
        - sku
        - uom
      properties:
        id:
          type: string
          format: uuid
        conversionFactor:
          type: number
        sku:
          type:
            - string
            - 'null'
        uom:
          $ref: '#/components/schemas/ItemUom'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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