Skip to main content
GET
/
api
/
v1
/
customers
Get All Customers
curl --request GET \
  --url https://api-production.fossapay.com/api/v1/customers \
  --header 'x-api-key: <x-api-key>'
{
  "status": "success",
  "statusCode": 200,
  "message": "Customers retrieved successfully",
  "data": [
    {
      "id": "fh8e2e1f-e253-23ac-b8ft-31ed2t7fb0df",
      "businessId": "xse5f9867-f6b3-4dda-9d1e-aa335fbf7a3a",
      "firstName": "John",
      "lastName": "Ben",
      "middleName": "Doe",
      "emailAddress": "john.doe@gmail.com",
      "mobileNumber": "0918458251",
      "dob": "1991-08-15",
      "customerType": "individual",
      "address": "12 customer rd.",
      "city": "Lagos",
      "createdAt": "2021-01-08T21:39:52+01:00"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 7,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Documentation Index

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

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

​
Overview

Retrieve a list of all customer accounts in your system.

​
Request

​
x-api-key
string
required
Your API key for authentication

​
Parameters

​
sortOrder
string
Sort order: asc or desc (default: desc)
​
sortBy
string
Field to sort by: createdAt, firstName, lastName, emailAddress (default: createdAt)
​
search
string
Search term to filter customers by name or email
​
limit
number
Number of customers to return per page (default: 10, max: 100)
​
page
number
Page number to retrieve (default: 1)

​
Response

​
status
string
Response status: success or error
​
statusCode
number
HTTP status code (200 for successful retrieval)
​
message
string
Human-readable response message
​
data
array
Array of customer objects
​
pagination
object

​
Response Example

{
  "status": "success",
  "statusCode": 200,
  "message": "Customers retrieved successfully",
  "data": [
    {
      "id": "fh8e2e1f-e253-23ac-b8ft-31ed2t7fb0df",
      "businessId": "xse5f9867-f6b3-4dda-9d1e-aa335fbf7a3a",
      "firstName": "John",
      "lastName": "Ben",
      "middleName": "Doe",
      "emailAddress": "john.doe@gmail.com",
      "mobileNumber": "0918458251",
      "dob": "1991-08-15",
      "customerType": "individual",
      "address": "12 customer rd.",
      "city": "Lagos",
      "createdAt": "2021-01-08T21:39:52+01:00"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 7,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

​
Example

curl -X GET "https://api-production.fossapay.com/api/v1/customers?sortOrder=desc&sortBy=createdAt&search=john&page=1&limit=10" \
  -H "x-api-key: YOUR_API_KEY"

​
Rate Limits

  • Maximum 100 requests per minute per API key
  • Burst limit of 20 requests per second