Swiftazu

Customers

List customers

Your customers, in pages, with search.

GET/v1/customers
Bearer tokenReturns JSONSuccess 200

search matches the name, mobile number, email and your own customer reference. summary gives totals for your whole customer list, not just this page.

Request

Headers

FieldTypeDescription
AuthorizationrequiredstringThe access token from Get token, as "Bearer <token>".

Query parameters

FieldTypeDescription
pageoptionalnumberThe page to return, starting at 1. Default 1.
pageSizeoptional10 | 25 | 50 | 100Rows per page. Default 25.
searchoptionalstringMatches name, mobile, email and your customer reference.
Example request
curl -X GET "https://api.swiftazu.com/v1/customers?page=1&pageSize=25" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

Example response · 200
{
  "rows": [
    {
      "id": "8778df1e-9b74-420d-b826-d17cdad86d36",
      "fullName": "Layla Hassan",
      "mobile": "+971558250908",
      "email": "layla.hassan@example.com",
      "customerReference": "CUST-1042",
      "addressCount": 1,
      "orderCount": 4
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 25,
  "summary": {
    "total": 1,
    "withAddresses": 1
  }
}

Errors

Every call can also return the shared errors listed on the Overview page. Overview