Authorizations
Authorization string header required Bearer authentication header of the formBearer <token>, where <token> is your REST API token.
Required Scope
customers:read
This endpoint requires the customers scope with Read Access. Configure token scopes in Settings → Integrations → REST API.
Path Parameters
id string required The platform customer ID (e.g. Shopify customer ID) Example:"9049402769586"
Response
200 - application/json The customer was successfully retrieved. data object Hide child attributes data.id string<uuid> Unique UUID identifier for the customer in Yuko. Example:"63a2c89a-9936-4bc0-9d5f-93db46110b76"
data.first_name
string | null
The customer’s first name.
Example:
"Jane"
data.last_name
string | null
The customer’s last name.
Example:
"Smith"
data.email
string
The customer’s email address.
Example:
"jane.smith@example.com"
data.phone
string | null
The customer’s phone number.
Example:
"+14155552671"
data.platform
string
The ecommerce platform the customer was synced from.
Example:
"shopify"
data.platform_customer_id
string | null
The customer’s unique identifier in the external platform.
Example:
"7823491023"
data.points
object
The customer’s loyalty points summary.
Hide child attributes
data.points.balance
integer
The customer’s current redeemable points balance.
Example:
350
data.points.earned
integer
Total points ever earned by the customer.
Example:
500
data.points.redeemed
integer
Total points redeemed by the customer.
Example:
150
data.tier
object | null
The customer’s current VIP tier. null if the customer has not reached any tier threshold.
Hide child attributes
data.tier.id
string<uuid>
Example:
"7fb39c85-3a3f-4247-8333-2e05a9c8ae28"
data.tier.name
string
Example:
"Silver"
data.tier.threshold_value
integer
Example:
500
data.tier.multiplier
number
Example:
1.5
data.membership
object
Loyalty membership summary.
Hide child attributes
data.membership.status
string
Always "active".
Example:
"active"
data.membership.member_since
string<date-time>
The date the customer joined the loyalty programme.
Example:
"2024-06-01T10:00:00.000Z"
data.created_at
string<date-time>
The date and time when the customer was created in Yuko.
Example:
"2024-06-01T10:00:00.000Z"
data.updated_at
string<date-time>
The date and time when the customer was last updated in Yuko.
Example:
"2026-02-15T08:30:00.000Z"