v1
latestOpenAPI 3.1.02026-07-226250251.5 KBCustomers
List Customers
Retrieve a list of customers filtered by type
get/v1/customers
Query parameters
type'INDIVIDUAL' | 'BUSINESS' required
Filter customers by type
per_pageinteger
Number of items to return per page
current_pageinteger
The page number to retrieve
Response
List of customers retrieved successfully
Example response
{
"data": {
"pagination": {
"current_page": 1,
"per_page": 10,
"total_page": 1,
"total": 2
},
"customers": [
{
"customer_id": "56c41b8e-e650-4f55-94f6-26a888a9b64d",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14724480512",
"country_of_residence": "USA",
"customer_status": "INCOMPLETE"
}
]
}
}