Skip to main content
GET
/
api
/
v2
/
customers
Search and list customers
curl --request GET \
  --url https://api.zupy.com/api/v2/customers/ \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "cpf": "<string>",
      "birth_date": "<string>",
      "points_balance": 123,
      "points_earned": 123,
      "points_spent": 123,
      "tier": "default",
      "card_number": "<string>",
      "join_date": "2023-11-07T05:31:56Z",
      "last_activity_date": "2023-11-07T05:31:56Z",
      "is_active": true,
      "zupy_balance": "<string>",
      "program_id": "<string>",
      "program_name": "<string>",
      "rfm_segment": "<string>",
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for partner access via APISIX key-auth plugin

Query Parameters

card_code
string

Filter by card number/code (case-insensitive contains)

cursor
string

Pagination cursor value from previous response.

email
string

Filter by email address (case-insensitive contains)

name
string

Filter by customer name (case-insensitive contains)

page_size
integer

Number of results to return per page.

phone
string

Filter by phone number (digits only, case-insensitive contains)

General text search across name, email, phone, and card code

segment
string

Filter by RFM segment (champions, loyal, promising, at_risk, new)

tier
string

Filter by loyalty tier (exact match: default, bronze, silver, gold, platinum, vip)

Response

data
object[]
required
meta
object
required