Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://api-sandbox.pavewaygroup.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "status_code": 200,
  "response_type": "success",
  "data": [
    {
      "id": "658dc...",
      "firstname": "John",
      "lastname": "Doe",
      "email": "[email protected]",
      "phone": "237612345678",
      "balance": 0,
      "active": true,
      "created_at": 1704873600
    }
  ]
}

Documentation Index

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

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

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent appearing first.

​
Authentication

Include your Secret Key in the Authorization header as a Bearer token.

​
Response

The response is a JSON object with a data field containing an array of customer objects.

​
Customer Object Fields

FieldTypeDescription
idstringUnique identifier for the customer.
firstnamestringCustomer’s first name.
lastnamestringCustomer’s last name.
emailstringCustomer’s email address.
phonestringCustomer’s phone number.
balancenumberCurrent account balance for the customer (in smallest currency unit).
activebooleanWhether the customer profile is currently active.
created_attimestampUnix timestamp when the customer was created.
{
  "status_code": 200,
  "response_type": "success",
  "data": [
    {
      "id": "658dc...",
      "firstname": "John",
      "lastname": "Doe",
      "email": "[email protected]",
      "phone": "237612345678",
      "balance": 0,
      "active": true,
      "created_at": 1704873600
    }
  ]
}