Retrieve a customer

curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/9049402769586" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const customerId = "9049402769586";

const response = await fetch(
  `https://api.yukoapp.com/api/v1/public/customers/${customerId}`,
  {
    method: "GET",
    headers: {
      Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
  }
);

const data = await response.json();

$customerId = "9049402769586";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/{$customerId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

{
  "data": {
    "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "phone": "+14155552671",
    "platform": "shopify",
    "platform_customer_id": "9049402769586",
    "state": "member",
    "date_of_birth": "1990-04-12",
    "referral_code": "JANE10",
    "referral_url": "https://example.com/pages/refer?ref=JANE10",
    "points": {
      "balance": 350,
      "earned": 500,
      "redeemed": 150
    },
    "tier": {
      "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
      "name": "Silver",
      "threshold_value": 500,
      "multiplier": 1.5,
      "icon": null,
      "benefits": [],
      "created_at": "2025-09-12T15:44:44+00:00"
    },
    "membership": {
      "status": "active",
      "member_since": "2024-06-01T10:00:00+00:00"
    },
    "created_at": "2024-06-01T10:00:00+00:00",
    "updated_at": "2026-02-15T08:30:00+00:00"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Customer not found"
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "Invalid or revoked API token"
  }
}

GET

public

customers

{id}

curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/9049402769586" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const customerId = "9049402769586";

const response = await fetch(
  `https://api.yukoapp.com/api/v1/public/customers/${customerId}`,
  {
    method: "GET",
    headers: {
      Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
  }
);

const data = await response.json();

$customerId = "9049402769586";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/{$customerId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

{
  "data": {
    "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "phone": "+14155552671",
    "platform": "shopify",
    "platform_customer_id": "9049402769586",
    "state": "member",
    "date_of_birth": "1990-04-12",
    "referral_code": "JANE10",
    "referral_url": "https://example.com/pages/refer?ref=JANE10",
    "points": {
      "balance": 350,
      "earned": 500,
      "redeemed": 150
    },
    "tier": {
      "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
      "name": "Silver",
      "threshold_value": 500,
      "multiplier": 1.5,
      "icon": null,
      "benefits": [],
      "created_at": "2025-09-12T15:44:44+00:00"
    },
    "membership": {
      "status": "active",
      "member_since": "2024-06-01T10:00:00+00:00"
    },
    "created_at": "2024-06-01T10:00:00+00:00",
    "updated_at": "2026-02-15T08:30:00+00:00"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Customer not found"
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "Invalid or revoked API token"
  }
}

The customer is enriched with their current VIP tier and loyalty membership status. To fetch many customers at once, use List customers.

Requires the read:customers scope. See Scopes.

Path parameters

string

required

The platform customer ID (for example, the Shopify customer ID).

Response

object

The customer. Has the properties of the Customer object, plus tier and membership.

Show customer properties

string<uuid>

Yuko’s unique identifier for the customer.

string | null

The customer’s first name.

string | null

The customer’s last name.

string | null

The customer’s email address.

string | null

The customer’s phone number.

string

The ecommerce platform the customer was synced from, for example shopify.

string | null

The customer’s unique identifier in the external platform.

enum<string>

member for active loyalty members, or disabled if the customer is banned from the loyalty program.

string<date> | null

The customer’s birthday in YYYY-MM-DD format, if collected.

string | null

The customer’s referral code. null if the customer has no referral code yet.

string | null

The customer’s referral link, built from the referral landing page URL plus ?ref=<referral_code>. null if there’s no referral code or no landing page URL is set.

object

The customer’s loyalty points summary.

Show points properties

integer

Current redeemable points balance. Always 0 for customers who are banned or excluded from the loyalty program by a customer tag.

integer

Total points ever earned.

integer

Total points redeemed.

object | null

The customer’s current VIP tier. null if the customer hasn’t reached a tier or VIP tiers are turned off. Has the same fields as a tier in List VIP tiers, including icon, benefits and created_at.

Show tier properties

string<uuid>

The tier’s unique identifier.

string

The tier’s name.

integer

The qualifying value needed to reach the tier.

number

The tier’s multiplier.

object

Loyalty membership summary.

Show membership properties

string

Always active.

string<date-time>

When the customer was created in Yuko (same as created_at).

string<date-time>

When the customer was created in Yuko (ISO 8601).

string<date-time>

When the customer was last updated in Yuko (ISO 8601).

Errors

Status	Code	When
`401`	`missing_token`, `invalid_token`	The API key is missing, wrong or revoked.
`403`	`insufficient_scope`	The key doesn’t have `read:customers`.
`404`	`not_found`	No customer matches `id`. Message: “Customer not found”.
`429`		The key exceeded the rate limit.

curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/9049402769586" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const customerId = "9049402769586";

const response = await fetch(
  `https://api.yukoapp.com/api/v1/public/customers/${customerId}`,
  {
    method: "GET",
    headers: {
      Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
  }
);

const data = await response.json();

$customerId = "9049402769586";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/{$customerId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

{
  "data": {
    "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "phone": "+14155552671",
    "platform": "shopify",
    "platform_customer_id": "9049402769586",
    "state": "member",
    "date_of_birth": "1990-04-12",
    "referral_code": "JANE10",
    "referral_url": "https://example.com/pages/refer?ref=JANE10",
    "points": {
      "balance": 350,
      "earned": 500,
      "redeemed": 150
    },
    "tier": {
      "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
      "name": "Silver",
      "threshold_value": 500,
      "multiplier": 1.5,
      "icon": null,
      "benefits": [],
      "created_at": "2025-09-12T15:44:44+00:00"
    },
    "membership": {
      "status": "active",
      "member_since": "2024-06-01T10:00:00+00:00"
    },
    "created_at": "2024-06-01T10:00:00+00:00",
    "updated_at": "2026-02-15T08:30:00+00:00"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Customer not found"
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "Invalid or revoked API token"
  }
}

Rest API

API References

Object Reference

Path parameters

Response

Errors

​Path parameters

​Response

​Errors

Path parameters

Response

Errors