Skip to main content

Retrieve Customer List

Introduction

Retrieve customer list

Interface

GET /v1/customers

Request Params

FieldNameTypeRangeExampleDefaultOptionalRemarkRule
referenceReferencestringoptional
pagePagestringrequired
per_pagePer Pagestringrequired
time_created[lt]Time Createdstringrequired
time_created[gt]Time Createdstringrequired
emailEmailstringoptional
phonePhonestringoptionalE.164

Response Params

Response Example

200 success:

{
"object": "list",
"url": "/v2/customers",
"has_more": false,
"data": [
{
"id": "cst_un9WL8ervLWDqTGW",
"object": "customer",
"account": "acct_yz50aD",
"time_created": "2022-07-15T14:00:46+08:00",
"livemode": true,
"reference": "2022000000000",
"first_name": "David",
"last_name": "Smith",
"company": "comany name",
"country": null,
"description": "company description",
"birth_date": "2020-01-01",
"email": "test@company.com",
"phone": "+8613000000000",
"deleted": false
}
]
}