read_customers
scope.
Payload
object
required
Customer object with the same shape as the Customers
API
response
Example
Example
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
read_customers
scope.
{
"id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
"topic": "customers/update",
"created_at": "2025-01-01T03:00:05.000Z",
"customer": {
"id": 1001,
"email": "alice@example.com",
"guest": false,
"blocked": false,
"birthday": "1970-01-01",
"enrolled": true,
"metadata": {},
"created_at": "2020-11-23T17:28:25.362Z",
"properties": {
"name": "Alice Blue",
"last_name": "Blue",
"first_name": "Alice"
},
"updated_at": "2025-02-13T00:00:11.535Z",
"enrolled_at": "2023-05-12T20:46:40.377Z",
"merchant_id": "5000001",
"referral_id": null,
"referred_by": null,
"points_spent": 0,
"referral_url": "https://prz.io/a",
"points_pending": 0,
"points_approved": 500,
"rewards_claimed": 0,
"rewards_used": 0,
"insights_segment": null,
"loyalty_tier_membership": {
"manual": false,
"expires_at": null,
"started_at": "2024-12-17T02:03:15.378Z",
"loyalty_tier": {
"id": 100,
"name": "Bronze",
"hidden": false,
"number": 1,
"default": true,
"position": 0,
"lower_bound": "0.00",
"upper_bound": "249.99"
}
},
"tier_eligibility": {
"kind": "points",
"valid_until": null,
"tier_points": {
"now": 150,
"at_expiration": null
},
"points_needed_for_renewal": null,
"points_needed_for_upgrade": 100,
"upgrade_tier": {
"id": 101,
"name": "Silver",
"threshold": 250
},
"forecasted_tier": null
}
}
}