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

# List customers

> The customer directory, most recently active first, cursor paginated. With `email`, an exact lookup that returns zero or one customer and ignores the other parameters.



## OpenAPI

````yaml /api-reference/openapi.json get /customers
openapi: 3.1.0
info:
  title: miniDesk API
  version: 1.0.0
  description: >-
    Create and work support tickets from your own systems. Every response
    carries an `X-Request-Id`; quote it when reporting a problem.
servers:
  - url: https://api.minidesk.ai/v1
security:
  - bearerAuth: []
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        The customer directory, most recently active first, cursor paginated.
        With `email`, an exact lookup that returns zero or one customer and
        ignores the other parameters.
      operationId: listCustomers
      parameters:
        - name: cursor
          in: query
          required: false
          description: The `next_cursor` from the previous page. Omit for the first page.
          schema:
            type: string
            maxLength: 512
            format: base64url
            contentEncoding: base64url
            pattern: ^[A-Za-z0-9_-]*$
        - name: limit
          in: query
          required: false
          description: How many customers to return. 1 to 100, default 25.
          schema:
            default: 25
            type: integer
            minimum: 1
            maximum: 100
        - name: email
          in: query
          required: false
          description: Only the customer with this address, ignoring case.
          schema:
            type: string
            maxLength: 254
            format: email
            pattern: >-
              ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
        - name: q
          in: query
          required: false
          description: Matches a name or an email address.
          schema:
            type: string
            minLength: 1
            maxLength: 200
      responses:
        '200':
          description: A page of customers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerList'
        '400':
          description: The body failed validation. `field` names the offending property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the rate limit. See the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CustomerList:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              email:
                anyOf:
                  - type: string
                  - type: 'null'
              name:
                anyOf:
                  - type: string
                  - type: 'null'
              external_id:
                anyOf:
                  - type: string
                  - type: 'null'
              is_verified:
                type: boolean
              note:
                anyOf:
                  - type: string
                  - type: 'null'
              created_at:
                type: string
            required:
              - id
              - email
              - name
              - external_id
              - is_verified
              - note
              - created_at
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - data
        - next_cursor
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - invalid_credential
                - identity_required
                - identity_invalid
                - forbidden
                - email_unconfirmed
                - seat_unavailable
                - not_found
                - conflict
                - quota_exceeded
                - invalid_transition
                - ai_disabled
                - rate_limited
                - internal_error
                - service_unavailable
            message:
              type: string
            field:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API credential from **Settings → API**, sent as `Authorization:
        Bearer mdsk_api_...`. Issued per workspace and shown once.

````

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