Skip to main content
Retrieves a paginated list of referral transactions where the customer was the advocate (the person who made the referral). Results are sorted by created_at in descending order. GET /public/customers/referrals

​
Authorizations

Authorization string header required Bearer authentication header of the form Bearer <token>, where <token> is your REST API token.

​
Required Scope

referrals:read This endpoint requires the referrals scope with Read Access. Configure token scopes in Settings → Integrations → REST API.

​
Query Parameters

customer_id string required The platform customer ID (e.g. Shopify customer ID) Example: "9049402769586"

​
Query Parameters

status enum<string> Filter results to only referrals with the provided status. Available options: pending, rewarded, cancelled, expired, fraudulent per_page integer default: 20 The number of results per page. Required range: 1 <= x <= 100 page integer default: 1 The page number to retrieve.

​
Response

200 - application/json data object[] Hide child attributes data.id string<uuid> Unique UUID identifier for the referral transaction. Example: "d4e5f6a7-b8c9-0123-defa-b01234567890" data.advocate_id string<uuid> The UUID of the referral advocate record for this customer. Example: "b2c3d4e5-f6a7-8901-bcde-f01234567890" data.friend_customer_id string<uuid> | null The UUID of the friend who was referred. null if the friend has not yet created an account. Example: "f8a9b0c1-d2e3-4567-fabc-d01234567890" data.order_id string<uuid> | null The UUID of the qualifying order that triggered the referral reward. null if not yet fulfilled. Example: "a0b1c2d3-e4f5-6789-abcd-e01234567890" data.referral_code string The referral code used by the friend to claim the referral. Example: "REF-XYZ-ABC" data.status enum<string> The current status of the referral transaction. Available options: pending, rewarded, cancelled, expired, fraudulent Example: "rewarded" data.created_at string<date-time> Example: "2026-01-20T14:00:00.000Z" data.updated_at string<date-time> Example: "2026-01-22T09:00:00.000Z" meta object Hide child attributes meta.pagination object Hide child attributes meta.pagination.current_page integer Example: 1 meta.pagination.per_page integer Example: 20 meta.pagination.total integer Example: 3 meta.pagination.last_page integer Example: 1 meta.pagination.has_more boolean Example: false 
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/referrals?customer_id=9049402769586?status=rewarded" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": [
    {
      "id": "d4e5f6a7-b8c9-0123-defa-b01234567890",
      "advocate_id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "friend_customer_id": "f8a9b0c1-d2e3-4567-fabc-d01234567890",
      "order_id": "a0b1c2d3-e4f5-6789-abcd-e01234567890",
      "referral_code": "REF-XYZ-ABC",
      "status": "rewarded",
      "created_at": "2026-01-20T14:00:00.000Z",
      "updated_at": "2026-01-22T09:00:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 1,
      "last_page": 1,
      "has_more": false
    }
  }
}