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

# List customers

> Lists the customers in the workspace, oldest first.

<Info>Replace `{your-subdomain}` with your workspace's subdomain. <br /> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).</Info>


## OpenAPI

````yaml bundled/customers.yaml GET /customers
openapi: 3.0.3
info:
  title: NeetoDesk APIs
  version: 2.0.0
servers:
  - description: NeetoDesk APIs
    url: https://{your-subdomain}.neetodesk.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /customers:
    get:
      summary: List customers
      description: Lists the customers in the workspace, oldest first.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/page_number_param'
        - in: query
          name: page_size
          description: >-
            Number of results per page. Defaults to 30 when omitted, and cannot
            exceed 100.
          required: false
          schema:
            type: integer
            default: 30
            maximum: 100
        - in: query
          name: email
          description: >-
            Return only the customer with this email address. The match is exact
            and case-insensitive.
          required: false
          schema:
            type: string
            example: john@example.com
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  customers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '422':
          description: Unprocessable Entity - `email` was not sent as a single string
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: email must be a string
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    page_number_param:
      in: query
      name: page_number
      description: >-
        Page of results to retrieve, starting from 1. Defaults to 1 when
        omitted.
      required: false
      schema:
        type: integer
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: aaaabbbb-cccc-dddd-eeee-ffff00002222
        name:
          type: string
          example: John Doe
        email:
          type: string
          description: Primary email address of the customer.
          example: john@example.com
        language:
          type: string
          example: English
        time_zone:
          type: string
          example: Eastern Time (US & Canada)
        description:
          type: string
          example: VIP customer
        created_at:
          type: string
          format: date-time
          example: '2026-09-01T10:15:30.000Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-09-03T08:42:11.000Z'
        emails:
          type: array
          description: All email addresses of the customer, including the primary one.
          items:
            type: string
          example:
            - john@example.com
            - john.doe@work.example.com
        phone_numbers:
          type: array
          description: All phone numbers of the customer.
          items:
            type: string
          example:
            - '+1234567890'
        company:
          type: object
          description: >-
            Company the customer belongs to. Present only when the customer
            belongs to a company.
          properties:
            id:
              type: string
              format: uuid
              example: aaaabbbb-cccc-dddd-eeee-ffff00001111
            name:
              type: string
              example: Acme Inc.
    Pagination:
      type: object
      properties:
        total_records:
          type: integer
          example: 95
        total_pages:
          type: integer
          example: 4
        current_page_number:
          type: integer
          example: 1
        page_size:
          type: integer
          example: 30

````

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