---
title: "EUD Guest Activities API"
method: GET
path: "/activities"
---

# EUD Guest Activities API

`GET /activities`

This page will help you get started with Guest Member API.

## Query parameters

- `start_cursor` integer
- `count` integer
- `language` string
- `sort_by` string

## Response `200`

200

- GuestActivitiesResponseObject
  - `total` integer — The total number of eligible activities.
  - `next_cursor` integer — This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.
  - `more` boolean
  - `activities` GuestActivitiesActivitiesObject
    - `activity_id` string — The unique ID of the activity assigned by Zinrelo.
    - `enduser_activity_description_html` string — "Points earning description HTML" configuration in Zinrelo admin console.
    - `activity_card_background_image_url` string — "Activity Tile Image" configuration in Zinrelo admin console.
    - `is_qualified_for_tier_upgrade` boolean — The activity qualifies for a tier upgrade.
    - `last_modified_date` string — The most recent date on which a transaction was updated.
    - `metadata` object — The metadata associated with an activity.
      - `Category` string
    - `enduser_activity_short_description` string — "Description" configuration in Zinrelo admin console.
    - `created_date` string — The date on which the activity was created.
    - `activity_name` string — The activity name stored with Zinrelo.
    - `is_points_expiry_reset_activity` boolean — The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration.
    - `id` string — The internal ID generated by Zinrelo.
    - `activity_benefit_type` string — Activity benefit type is based on activity_type. Like for example: - fixed activity type- points activity benefit type - fixed_and_coupon_based activity type- points_and_coupon_code activity benefit type - bonus_multiplier activity type- points activity benefit type - bonus_and_coupon_based activity type- points_and_coupon_code activity benefit type - coupon_based activity type- coupon_based activity benefit type
    - `points_config` GuestActivitiesPointsConfigObject
      - `points_computation_type` string — <p><span style="font-weight: 400;">Points computation provides information about how the base points for various activities within our program are calculated, encompassing multiple fields within the points config.</span></p> <p>&nbsp;</p> <p><span style="font-weight: 400;">For certain activities like 'Share On Facebook' and 'Write a Review' within our program, a fixed set of points is allocated upon completion. In these instances, the points computation type is designated as "fixed." The points configuration includes an additional field specifying the exact number of fixed points awarded upon successful activity completion. For instance:</span></p> <p><span style="font-weight: 400;">{</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> "points": 100,</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> "points_computation_typ": &ldquo;fixed_points&rdquo;</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> }</span></p> <p><span style="font-weight: 400;">Conversely, some activities such as&nbsp; 'Purchase on Website' and 'Submit a Receipt' within our program grant points based on multiples of a particular value. For instance, when a purchase is made on the website, points are awarded in multiples of the order subtotal. This scenario falls under the points computation type "multiplier_based." The points configuration contains a "multiplier" field and attribute, utilized to multiply the awarded points based on the specified value.</span></p> <p><span style="font-weight: 400;">{</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> "multiplier": 2,</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> &ldquo;attribute_to_multiply&rdquo;: &ldquo;order_subtotal&rdquo;</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> "points_computation_type": &ldquo;multiplier_based&rdquo;</span><span style="font-weight: 400;"><br /></span><span style="font-weight: 400;"> }</span></p> <p><span style="font-weight: 400;">However, certain activities within the program do not provide any points. These instances occur when the benefit type solely involves coupons. In such cases, the points configuration remains empty, rendering points computation unavailable.</span></p>
      - `attribute_to_multiply` string — If points_computation_type is multiplier based then points config will have attribute_to_multiply and multiplier field along with points_computation_type. Attribute to multiply can have different fields based on activity id. For example- - made_a_purchase actvity will have order_subtotal - submit_a_receipt activity will have receipt_order_value For referral activity based on referrer_payoff_type attribute will have different attribute to multiply fields such as: - percent_purchase_points referrer payoff type will have purchase_points - percent_order_value referrer payoff type will have order_value
      - `multiplier` integer — The digit that will be multiplied.
    - `extra_config` GuestActivitiesExtraConfigObject
      - `share_current_page_url` boolean — The shared url for Facebook/ Pinterest.
      - `pin_post_image` string — The image for a Pinterest post. This can be uploaded through the admin console on the Activity Setting page by using the 'Post Image' feature.
      - `pin_post_description` string — The description for 'Share on Pinterest' can be set within the admin console by adjusting the text within the 'Post Description' text box.
      - `max_award_frequency_error_text` string — The error message displayed when a member exceeds the defined frequency limit.
      - `personal_handle_edit_button_text` string — The text displayed on the button for editing the personal handle.
      - `duplicate_handle_error_text` string — The message shown when a member attempts to submit a duplicate handle for Instagram or TikTok.
      - `personal_handle_submit_button_text` string — The text displayed on the button for submit the personal handle.
      - `handle_required_alert_text` string — The alert message displayed when an Instagram or TikTok handle is required but has not been provided.
      - `activity_start_button_text` string — The text displayed on the start button for Instagram or TikTok activities.
      - `failure_text` string — The message displayed when an issue occurs or an operation fails.
      - `thank_you_text` string — The thank message including details about the points a member will earn.
      - `cancel_button_text` string — The text displayed on the cancel button for Instagram or TikTok activities.
      - `excluded_transaction_error_text` string — The text displayed on exclusion rule for Instagram or TikTok activities.
      - `enter_handle_prompt_text` string — The description text to enter Instagram or TikTok handle.
      - `personal_handle_input_text` string — The input text for Instagram or TikTok handle.
      - `blocked_handle_error_text` string — The message displayed when a blocked Instagram or TikTok handle is submitted.
      - `name_header_text` string — The activity header text displayed in end user dashboard for Instagram or TikTok activities.
      - `enter_handle_placeholder_text` string — The placeholder text to enter the TikTok or Instagram.
      - `edit_handle_text` string — The text displayed on end user dashboard to edit Instagram or TikTok handle.
      - `business_handle_display_text` string — The display text for business handle.
      - `business_instagram_username` string — The username of the Instagram user.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/versions/c12d3d379897/schema)