---
title: "List all customers"
method: GET
path: "/api/v1/customer"
tags: ["Customers"]
---

# List all customers

`GET /api/v1/customer`

## Request

- Base URL: `https://api.crossborder.jiopay.co.in`
- URL: `https://api.crossborder.jiopay.co.in/api/v1/customer`
- Auth: HTTP bearer

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

## Query parameters

- `customer_type` 'individual' | 'business': The type of customer
- `email_address` string
- `tax_identification_number` string
- `before` string
- `after` string
- `per_page` integer
- `page` integer

## Response `200`

OK

- CustomerListResponse
  - `data` CustomerResponse[]: List of customers, most recently created first.
    - `id` string: The unique identifier for the customer.
    - `name` string: The name of the customer.
    - `customer_type` 'individual' | 'business': The type of customer
    - `email` string, email: The email address of the customer.
    - `phone` string: The phone number of the customer, with country code. Phone number validation is done using the phonelib library.
    - `dob` string: The date of birth of the customer
    - `nationality` string: The nationality of the customer
    - `tax_identification_number` string: Applicable only to the LRS (Liberalised Remittance Scheme / resident-India remittance) flow. The customer's PAN (tax identification number), populated only for customers onboarded under LRS and absent otherwise. Searchable via the tax_identification_number query parameter on the list-customers endpoint.
    - `address` string: The street address of the customer.
    - `city` string: The city where the customer is located.
    - `state` string: The state where the customer is located.
    - `country` string, iso-3166-1-alpha-3: The country where the customer is located. Country should be sent as an ISO 3166-1 alpha-3 code.
    - `pincode` string: The postal code/pincode of the customer's address. See the list of countries where pincode is mandatory.
    - `status` string: The status of the customer.
    - `created_at` string, timestamp: Timestamp representing when the customer was created
    - `updated_at` string, timestamp: Timestamp representing when the customer was last updated
  - `page_meta` PageMeta
    - `current` integer: The current page number.
    - `previous` integer, nullable: The previous page number.
    - `next` integer, nullable: The next page number.
    - `per_page` integer: The number of items per page.
    - `pages` integer: The total number of pages.
    - `count` integer: The total number of items.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/jiopay/apis/cross-border.md) - [All operations](https://skmtc.dev/jiopay/apis/cross-border/llms.txt) - [OpenAPI document](https://skmtc.dev/jiopay/apis/cross-border/revisions/b3e97f5918d4?raw)