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.

GETapi-prod.blaaiz.com/api/external/customer

Authorization

oauth2ClientCredentials customer:read

AuthorizationBearer <token>

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

In: header

Scope: customer:read

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?string

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

Value in

"PENDING"
"PROCESSING"
"VERIFIED"
"REJECTED"

type?string

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

Value in

"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.

Range1 <= value

Response Body

`application/json`

List all customers

curl --request GET \  --url 'https://example.com/api/external/customer?paginate=true'

{  "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"    }  ]}