Skip to main content
GET
/
api
/
external
/
customer
List all customers
curl --request GET \
  --url https://api-prod.blaaiz.com/api/external/customer \
  --header 'Authorization: Bearer <token>'
{
  "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

​
Authorization
string
header
required

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

Query Parameters

​
email
string

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.

​
id_number
string

Exact-match filter on the customer's government-issued ID number.

​
registration_number
string

Exact-match filter on the business customer's registration / incorporation number.

​
verification_status
enum<string>

Filter by verification status. Lowercase input is normalized to upper-case.

Available options:
PENDING,
PROCESSING,
VERIFIED,
REJECTED
​
type
enum<string>

Filter by customer type. Upper-case input is normalized to lower-case.

Available options:
individual,
business
​
paginate
boolean

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
integer

Page number to fetch when paginate=true. Defaults to 1. Ignored when pagination is not enabled.

Required range: x >= 1

Response

Customers retrieved successfully. The response body is the legacy CustomerListResponse shape by default, and the PaginatedCustomerListResponse shape when paginate=true was sent.

Default (unpaginated) response shape returned when paginate is omitted or not truthy.

​
message
string
required
​
data
object[]
required