List Customer Accounts

In cases where you need to access customers in your project, this allows users to retrieve a list of customer accounts from the system. This endpoint provides essential details about each customer account, which can be used for various administrative, analytical, or customer support purposes.

Endpoint

{{baseurl}}/customers

This is a GET request.

This is what a successful request should look like:

{
  "success": true,
  "statusCode": 200,
  "message": "Fetched list of customers",
  "data": {
    "customers": [
      {
        "id": "326a18a1-441a-457d-ba28-0538e0717c92",
        "email": "test@payshiga.com",
        "firstName": "test",
        "lastName": "testing",
        "city": "Bariga",
        "state": "Lagos",
        "country": "Nigeria",
        "zipCode": "100231",
        "line1": "123, Payshiga road",
        "line2": null,
        "phoneNumber": "+2348123456789",
        "house": "Zk9",
        "dateOfBirth": "2002-10-29T00:00:00.000Z",
        "idType": null,
        "idNumber": null,
        "document": null,
        "imageURL": null,
        "reference": "w72hs8shshshshw8s8292ushs",
        "createdAt": "2024-05-01T22:10:44.329Z",
        "status": "UNVERIFIED",
        "reason": null,
        "businessId": "0bb1dfc6-a74c-4e53-b41a-4a0c1eab188e"
      }
    ],
    "metadata": {
      "total": 1
    }
  }
}