Customers

Get customer list

Retrieves a paginated list of customers.

get/api/v1/customer

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/customer/get.ts
A function with typed inputs. Its response is checked against the schema.

pageinteger

Page number for pagination (starting from 0)

limitinteger

Number of items per page

emailstring email

Example:john.doe@example.com

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

phonestring

Example:+2348192837465

Filter by customer phone number in E.164 format.

List of customers retrieved successfully.

pageinteger

Current page number

totalinteger

Total number of customers matching the query

No recorded changes to this operation across all 1 revision of this API.