Skip to main content
GET
/
customers
List All Customers
curl --request GET \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1247,
  "next": "https://webmaster.zupers.com.br/api/loyalty/v1/customers/?limit=20&offset=20",
  "previous": "<string>",
  "results": [
    {
      "id": "cust_1234567890",
      "card_number": "ZUP001234567",
      "user": {
        "name": "João Silva",
        "email": "[email protected]",
        "whatsapp_number": "+5511999999999",
        "cpf": "12345678901"
      },
      "points_balance": 1250,
      "points_earned": 5780,
      "points_spent": 4530,
      "tier": "Gold",
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_activity_date": "2023-11-07T05:31:56Z",
      "transaction_count": 47,
      "loyalty_program": {
        "program_name": "Miola Rewards",
        "currency_name": "ZupCoins",
        "currency_symbol": "ZC"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Query Parameters

​
limit
integer
default:20

Number of results per page (max 100)

Required range: x <= 100
​
offset
integer
default:0

Number of results to skip for pagination

​
ordering
enum<string>

Field to order results by. Prefix with - for descending order

Available options:
name,
-name,
created_at,
-created_at,
last_activity_date,
-last_activity_date,
points_balance,
-points_balance
Example:

"-created_at"

Response

Customers retrieved successfully

​
count
integer
Example:

1247

​
next
string<uri> | null
Example:

"https://webmaster.zupers.com.br/api/loyalty/v1/customers/?limit=20&offset=20"

​
previous
string<uri> | null
​
results
object[]