curl --request GET \
--url https://api-prod.blaaiz.com/api/external/customer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.blaaiz.com/api/external/customer"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.blaaiz.com/api/external/customer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api-prod.blaaiz.com/api/external/customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.blaaiz.com/api/external/customer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Customers retrieved successfully.",
"data": [
{
"id": "customer_123",
"type": "individual",
"first_name": "John",
"last_name": "Doe",
"business_name": null,
"registration_number": null,
"id_number": "A01234567",
"email": "john@example.com",
"phone": "+2348012345678",
"verification_status": "VERIFIED",
"created_at": "2026-01-15T10:30:00Z"
},
{
"id": "customer_456",
"type": "business",
"first_name": null,
"last_name": null,
"business_name": "Acme Corp",
"registration_number": "RC1234567",
"id_number": null,
"email": "contact@acme.com",
"phone": "+2348012345679",
"verification_status": "VERIFIED",
"created_at": "2026-01-14T09:20:00Z"
}
]
}List all customers
Retrieve customers for your business. Supports optional exact-match filters on email, id_number, registration_number, verification_status, and type, and opt-in pagination via paginate=true. Filters and pagination compose.
When paginate is omitted or not truthy, the response shape is unchanged ({message, data: [...]}). When paginate=true, the response is a paginated envelope ({message, data: [...], links: {...}, meta: {...}}) with 15 items per page. Use the ?page=N query string (in addition to paginate=true) to fetch subsequent pages.
Ordering: the paginated path returns results newest-first (by created_at descending). The default unpaginated path preserves the legacy database-order semantics for backwards compatibility — if you need a guaranteed order, opt in to paginate=true.
Required scope: customer:read.
curl --request GET \
--url https://api-prod.blaaiz.com/api/external/customer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.blaaiz.com/api/external/customer"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.blaaiz.com/api/external/customer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api-prod.blaaiz.com/api/external/customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.blaaiz.com/api/external/customer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Customers retrieved successfully.",
"data": [
{
"id": "customer_123",
"type": "individual",
"first_name": "John",
"last_name": "Doe",
"business_name": null,
"registration_number": null,
"id_number": "A01234567",
"email": "john@example.com",
"phone": "+2348012345678",
"verification_status": "VERIFIED",
"created_at": "2026-01-15T10:30:00Z"
},
{
"id": "customer_456",
"type": "business",
"first_name": null,
"last_name": null,
"business_name": "Acme Corp",
"registration_number": "RC1234567",
"id_number": null,
"email": "contact@acme.com",
"phone": "+2348012345679",
"verification_status": "VERIFIED",
"created_at": "2026-01-14T09:20:00Z"
}
]
}Authorizations
Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
Query Parameters
Exact-match filter on customer email. Validated as a plain string (not the email rule) so any value you successfully created the customer with is recoverable.
Exact-match filter on the customer's government-issued ID number.
Exact-match filter on the business customer's registration / incorporation number.
Filter by verification status. Lowercase input is normalized to upper-case.
PENDING, PROCESSING, VERIFIED, REJECTED Filter by customer type. Upper-case input is normalized to lower-case.
individual, business Opt in to the paginated response shape. Pass true (or any truthy value, e.g. 1) to receive {message, data, links, meta} with 15 items per page. Any other value — or omitting the parameter — returns the legacy {message, data} shape unchanged.
Page number to fetch when paginate=true. Defaults to 1. Ignored when pagination is not enabled.
x >= 1Response
Customers retrieved successfully. The response body is the legacy CustomerListResponse shape by default, and the PaginatedCustomerListResponse shape when paginate=true was sent.
Was this page helpful?