Skip to main content
GET
/
api
/
v1
/
customers
Retrieve all customers for a merchant
curl --request GET \
  --url https://dev.superpool.unyte.africa/api/v1/customers/ \
  --header 'X-API-Key: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "data": [
        {
          "customer_name": "Adeola Okonkwo",
          "customer_email": "[email protected]",
          "customer_phone": "08168518263"
        },
        {
          "customer_name": "Alphoso Thracian",
          "customer_email": "[email protected]",
          "customer_phone": "+123456789"
        },
        {
          "customer_name": "Alphoso Tracian",
          "customer_email": "[email protected]",
          "customer_phone": "+2348012345678"
        },
        {
          "customer_name": "Baby Owner",
          "customer_email": "[email protected]",
          "customer_phone": "+1122334455"
        }
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

Response

View all customers

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"