List customers
curl --request GET \
--url https://{host}/v1/customers \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/customers"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_type": "individual",
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"kyc_tier": 123,
"kyc_status": "<string>",
"status": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"email": "adaeze.okafor@example.com",
"alias": "Mama Ada"
}
],
"next_cursor": "<string>"
},
"code": "13"
}Customers
List customers
Lists the business’s customers, newest first. Filter by status, name search, phone, email, KYC tier or creation date; page with the cursor.
Required permission: feature:CUSTOMERS, customers:read
GET
/
v1
/
customers
List customers
curl --request GET \
--url https://{host}/v1/customers \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/customers"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_type": "individual",
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"kyc_tier": 123,
"kyc_status": "<string>",
"status": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"email": "adaeze.okafor@example.com",
"alias": "Mama Ada"
}
],
"next_cursor": "<string>"
},
"code": "13"
}