1. Customers
Rewrd API
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • Restrict a Customer
      PATCH
    • Unrestrict a Customer
      PATCH
  • Merchant
    • Get Merchant Configuration
      GET
    • Update Merchant Configuration
      PATCH
    • List Earning Rules
      GET
    • Get Earning Rule Details
      GET
    • List Merchant IPs
      GET
    • Add Merchant IP
      POST
    • Update Merchant IP
      PATCH
    • Delete Merchant IP
      DELETE
    • Get Merchant Analytics
      GET
  • Points
    • Process a Unified Points Transaction
      POST
    • Get Customer Transaction History
      GET
  1. Customers

List Customers

Development Server
https://rewrd-api-staging.fly.dev/v1
Development Server
https://rewrd-api-staging.fly.dev/v1
GET
/customers
Retrieves a paginated list of all customers belonging to your merchant account.
You can filter results by email or phone_number to quickly find specific customers. Results are sorted by creation date (newest first).

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Responses

🟢200OK
application/json
List of customers retrieved successfully.
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rewrd-api-staging.fly.dev/v1/customers?page=1&limit=20&email=jane@example.com&phone_number=+2348012345678' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Customers retrieved successfully",
    "data": [
        {
            "uid": "26833813",
            "email": "jane@example.com",
            "phone_number": "+2348012345678",
            "first_name": "Jane",
            "last_name": "Doe",
            "date_of_birth": "1995-06-15",
            "status": "active",
            "points_balance": 1500,
            "created_at": "2026-01-15T10:30:00.000Z"
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 50,
        "total": 150,
        "total_pages": 3
    }
}
Modified at 2026-04-07 21:05:20
Previous
Create a Customer
Next
Get a Customer
Built with