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



## OpenAPI

````yaml /technical-reference/openapi.yaml get /api/v1/customers
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/customers:
    get:
      summary: List customers
      operationId: listCustomers
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: cursor
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Customer page
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
                  nextCursor:
                    type:
                      - string
                      - 'null'
        '401':
          description: Missing or invalid token
        '403':
          description: Missing customers:read scope
      security:
        - bearerAuth: []
components:
  schemas:
    Customer:
      type: object
      required:
        - id
        - customerNumber
        - name
        - email
        - phone
        - status
        - createdAt
        - updatedAt
        - paymentTermsDays
        - terms
        - customerGroup
        - paymentMethod
        - addresses
        - contacts
      properties:
        id:
          type: string
          format: uuid
        customerNumber:
          type: string
        name:
          type: string
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        paymentTermsDays:
          type: integer
        terms:
          oneOf:
            - $ref: '#/components/schemas/CustomerTerms'
            - type: 'null'
        customerGroup:
          oneOf:
            - $ref: '#/components/schemas/CustomerGroup'
            - type: 'null'
        paymentMethod:
          type:
            - string
            - 'null'
        addresses:
          type: array
          description: Always present. Empty when the customer has no addresses.
          items:
            $ref: '#/components/schemas/CustomerAddress'
        contacts:
          type: array
          description: Always present. Empty when the customer has no contacts.
          items:
            $ref: '#/components/schemas/CustomerContact'
    CustomerTerms:
      type: object
      required:
        - id
        - code
        - name
        - netDays
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        name:
          type: string
        netDays:
          type: integer
    CustomerGroup:
      type: object
      required:
        - id
        - code
        - name
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        name:
          type: string
    CustomerAddress:
      type: object
      required:
        - id
        - type
        - label
        - line1
        - line2
        - city
        - state
        - postalCode
        - country
        - isDefault
        - isBillTo
        - isShipTo
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
        label:
          type:
            - string
            - 'null'
        line1:
          type:
            - string
            - 'null'
        line2:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        postalCode:
          type:
            - string
            - 'null'
        country:
          type: string
        isDefault:
          type: boolean
        isBillTo:
          type: boolean
        isShipTo:
          type: boolean
    CustomerContact:
      type: object
      required:
        - id
        - name
        - title
        - email
        - phone
        - isDefault
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        title:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        isDefault:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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