Skip to main content
GET
Afriex SDK
Retrieve a paginated list of all customers associated with your business.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint is rejected with a 401 Unauthorized response, the same response an unrecognised, malformed or revoked key returns. The API does not distinguish the two cases on the wire. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Query Parameters

page
integer
default:0

Page number for pagination (starting from 0)

Required range: x >= 0
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
email
string<email>

Filter by customer email address (exact match, case-insensitive).

Example:

"john.doe@example.com"

phone
string

Filter by customer phone number in E.164 format.

Example:

"+2348192837465"

Response

List of customers retrieved successfully.

data
object[]
page
integer

Current page number

total
integer

Total number of customers matching the query