GET
/
customers
curl --request GET \
  --url https://api.mpesaflow.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "balance": "<string>",
      "livemode": true,
      "metadata": "<string>",
      "currency": "<string>",
      "email": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "lastActiveAt": "<string>"
    }
  ],
  "pagination": {
    "totalCount": 123,
    "maxPage": 123,
    "currentPage": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required
Example:

"Bearer SECRET"

Query Parameters

​
query
string
​
page
number
default:1
Required range: x >= 1
​
limit
number
default:10
Required range: 1 <= x <= 100
​
sort_field
enum<string>
default:createdAt
Available options:
createdAt,
updatedAt,
name,
balance,
email
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc

Response

200
application/json

List of all customers

The response is of type object.