---
title: "List Referral Code Holders"
method: GET
path: "/v1/referrals/members/{memberId}/holders"
tags: ["Referrals"]
---

# List Referral Code Holders

`GET /v1/referrals/members/{memberId}/holders`

Retrieves the holders of the referral code from a referral campaign.

To use this endpoint, you must have the following permissions:

- Read Customers (`customers.details.read`)

> 📘 Alternative endpoint
>
>This endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the `campaignId` as a path paremeter.

## Query parameters

- `limit` integer
- `order` 'id' | '-id'
- `starting_after_id` string
- `filters` ParameterFiltersListReferralsRedeemableHolders
  - `id` object — Unique redeemable holder ID, i.e. `rh_0e77502f84f0f4a6a8`.
    - `conditions` FilterConditionsString — Data filters used to narrow down the data records to be returned in the result.
      - `$in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$not_in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$is` string — Value is exactly this value (single value).
      - `$is_not` string — Results omit this value (single value).
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$starts_with` string — Value starts with the specified string.
      - `$ends_with` string — Value ends with the specified string.
      - `$contains` string — Value includes the specified string.
      - `$not_contain` string — Value does NOT include the specified string.
  - `created_at` object — Timestamp representing the date and time when the redeemable was added to the holder. The value is shown in the ISO 8601 format.
    - `conditions` FilterConditionsDateTime — Data filters used to narrow down the data records to be returned in the result.
      - `$after` string, date-time — Value is after this date. The value for this parameter is shown in the ISO 8601 format.
      - `$before` string, date-time — Value is before this date. The value for this parameter is shown in the ISO 8601 format.
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$more_than` integer — Value is more days ago before the current date and time, e.g. more than `10` days ago.
      - `$less_than` integer — Value is less days before the current date and time, e.g. less than `10` days ago.
  - `holder_role` object — Holder role of the redeemable. Allowed values: `REFEREE`, `REFERRER`
    - `conditions` object
      - `$in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$not_in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$is` 'REFEREE' | 'REFERRER' — Value is exactly this value (single value).
      - `$is_not` 'REFEREE' | 'REFERRER' — Results omit this value (single value).
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$starts_with` string — Value starts with the specified string.
      - `$ends_with` string — Value ends with the specified string.
  - `customer_id` object — Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.
    - `conditions` FilterConditionsString — Data filters used to narrow down the data records to be returned in the result.
      - `$in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$not_in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$is` string — Value is exactly this value (single value).
      - `$is_not` string — Results omit this value (single value).
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$starts_with` string — Value starts with the specified string.
      - `$ends_with` string — Value ends with the specified string.
      - `$contains` string — Value includes the specified string.
      - `$not_contain` string — Value does NOT include the specified string.
  - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE.

## Response `200`

Returns the holders of the redeemable that is assigned to the referral campaign.

- ReferralsMembersHoldersListResponseBody — List of Holder's Redeemables
  - `object` string, required — The type of the object represented by JSON. This object stores information about redeemables holders
  - `data_ref` string, required — Identifies the name of the JSON property that contains the array of holders.
  - `data` RedeemableHolder[], required — A dictionary that contains an array of holders.
    - `id` string, required — Unique identifier of the redeemable holder.
    - `created_at` string, date-time, required — Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.
    - `redeemable_id` string, required — Identifier of the redeemable item.
    - `redeemable_object` string, required — Type of the redeemable.
    - `customer_id` string, required — Unique identifier of the customer.
    - `holder_role` 'OWNER' | 'REFERRER' | 'REFEREE', required — Role of the holder.
    - `campaign_id` string, required — Unique identifier of the campaign as assigned by Voucherify.
    - `campaign_type` 'REFERRAL_PROGRAM', required — Defines the type of the campaign.
    - `voucher_type` 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD', required — Defines the type of the voucher.
    - `metadata` object — A set of custom key/value pairs that you can attach to a redeemable holder. The metadata object stores all custom attributes assigned to the `redeemable_holder` object.
    - `object` 'redeemable_holder', required — The type of the object represented by JSON.
  - `total` integer, required — Total number of holders assigned to the redeemable.
  - `has_more` boolean, required — As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results.
  - `more_starting_after` string — Returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID.

## Other responses

- `404` — Returns an error if a resource is not found.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/versions/4982266e0494/schema)