GET
/
customers
/
list
Customers - List
curl --request GET \
  --url https://sandbox.hyperswitch.io/customers/list \
  --header 'api-key: <api-key>'
[
  {
    "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "Jon Test",
    "email": "JonTest@test.com",
    "phone": "9123456789",
    "phone_country_code": "+65",
    "description": "First Customer",
    "address": {
      "city": "New York",
      "country": "AF",
      "line1": "123, King Street",
      "line2": "Powelson Avenue",
      "line3": "Bridgewater",
      "zip": "08807",
      "state": "New York",
      "first_name": "John",
      "last_name": "Doe"
    },
    "created_at": "2023-01-18T11:04:09.922Z",
    "metadata": {},
    "default_payment_method_id": "pm_djh2837dwduh890123"
  }
]

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query Parameters

​
offset
integer | null

Offset for pagination

Required range: x >= 0
​
limit
integer | null

Limit for pagination

Required range: x >= 0

Response

200
application/json

Customers retrieved

The response is of type object[].