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

# List Customers

> Returns all customers registered under your organization.

<Prompt description="List Customers" actions={["cursor"]}>
  Integrate the DollarPe List Customers endpoint into my application.

  Endpoint: GET /customer/list
  Base URL: [https://api.dollarpe.in](https://api.dollarpe.in) (production) | [https://sandbox.dollarpe.in](https://sandbox.dollarpe.in) (sandbox)

  Auth headers required on every request:

  * X-API-KEY: your API key
  * X-TIMESTAMP: current Unix time in seconds
  * X-SIGNATURE: Base64(HMAC-SHA256(X-API-KEY + X-TIMESTAMP + sortedJSONBody, apiSecret))

  Task: Write a typed function that:

  1. Builds the auth headers
  2. Calls GET /customer/list
  3. Returns the list of customer objects
  4. Handles pagination if supported
  5. Handles 500 errors

  Language: TypeScript
</Prompt>

| API Status Code | Response               | Reason                |
| --------------- | ---------------------- | --------------------- |
| 500             | Internal Server Error. | Internal Server Error |


## OpenAPI

````yaml GET /customer/list
openapi: 3.1.0
info:
  title: DollarPe API
  description: API for DollarPe - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.dollarpe.xyz/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
  - url: https://sandbox.dollarpe.xyz/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
security:
  - ApiKeyAuth: []
    TimestampAuth: []
    SignatureAuth: []
tags:
  - name: Customer
    description: Customer related operations
    x-displayName: Customer
    x-traitTag: true
  - name: Payout
    description: Payout related operations
  - name: Webhooks
    description: Webhook related operations
  - name: Widget
    description: Hosted buy/sell widget session initialization
paths:
  /customer/list:
    get:
      tags:
        - Customer
      description: List all customers
      responses:
        '200':
          description: List of customers fetched successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      count:
                        type: integer
                        example: 1
                      next:
                        type: string
                        nullable: true
                        example: null
                      previous:
                        type: string
                        nullable: true
                        example: <url>
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              example: 550e8400-e29b-41d4-a716-446655440000
                            status:
                              type: string
                              example: VERIFIED
                            full_name:
                              type: string
                              example: John Doe
                            email:
                              type: string
                              example: john.doe@example.com
                            phone:
                              type: string
                              example: '+1234567890'
                            country:
                              type: string
                              example: USA
                            client_reference_id:
                              type: string
                              example: cust_12345
                            type:
                              type: string
                              example: INDIVIDUAL
                            failure_reason:
                              type: 'null'
                              example: null
                            non_residence_status:
                              type: boolean
                              example: true
                            residence_alpha_3_country_code:
                              type: string
                              example: USA
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
                  data:
                    type: 'null'
      servers:
        - url: https://sandbox.dollarpe.xyz/cms/api/v1
          description: Customer API Base URL
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for authentication
    TimestampAuth:
      type: apiKey
      in: header
      name: X-TIMESTAMP
      description: Current timestamp in seconds since epoch
    SignatureAuth:
      type: apiKey
      in: header
      name: X-SIGNATURE
      description: HMAC SHA256 signature of the request encoded in Base64

````