Skip to main content
GET
/
api
/
v2
/
customers
/
{id}
Get customer profile
curl --request GET \
  --url https://api.zupy.com/api/v2/customers/{id}/ \
  --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

Path Parameters

id
string
required

Unique identifier for this customer.

Response

data
object
required

Customer profile with personal details, loyalty status, and contact information.

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.