Skip to main content
GET
/
api
/
v1
/
customer
Get customer list
curl --request GET \
  --url https://staging.afx-server.com/api/v1/customer \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "customerId": "<string>",
      "fullName": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "countryCode": "<string>",
      "kyc": {},
      "meta": {}
    }
  ],
  "page": 123,
  "total": 123
}
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

Response

List of customers retrieved successfully.

data
object[]
page
integer

Current page number

total
integer

Total number of pages available