Skip to main content
GET
/
api
/
v1
/
customer
Get customer list
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/customer \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "name": "Addams Oshay",
      "email": "addams@example.com",
      "phone": "+15086340138",
      "customerId": "6929843e2c4653277440acc0",
      "countryCode": "US",
      "createdAt": "2025-11-28T11:15:10.812Z",
      "updatedAt": "2025-11-28T11:15:10.812Z"
    },
    {
      "name": "Daniel Obirije",
      "email": "daniel@example.com",
      "phone": "+2347049861191",
      "customerId": "6930610b0d8aab4a00b3f918",
      "countryCode": "NG",
      "createdAt": "2025-12-03T16:10:51.291Z",
      "updatedAt": "2025-12-03T16:10:51.291Z"
    }
  ],
  "total": 1448,
  "page": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.afriex.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of all customers associated with your business.

Authorizations

​
x-api-key
string
header
required

Static business API key from the dashboard

Query Parameters

​
page
integer
default:0

Page number for pagination (starting from 0)

Required range: 0 <= x <= 100
​
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 50
​
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 pages available