Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

Retrieve a Loyalty Member Details API

get/member

Response

200

last_namestring

The last name of the member.

twitter_handlestring

The twitter handle of the member.

lifetime_points_expiredinteger

The total points expired from a member's account since he joined the program.

last_modified_datestring

The most recent date on which a member's profile was updated.

available_pointsinteger

The avaliable points of the member.

pending_pointsinteger

The pending points of the member.

lifetime_points_earnedinteger

The total points earned in a member's account since he joined the program.

referral_URLstring

The unique referral url of the member.

member_statusstring

The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program.

referral_codestring

The unique referral code of the member.

email_addressstring

The email address of the member.

idstring

The internal ID generated by Zinrelo.

first_namestring

The first name of the member.

member_tagsstring[]

The tags assocaited with a member.

first_purchase_datestring

The first purchase date of the member.

lifetime_points_deductedinteger

The total points deducted from a member's account since he joined the program.

phone_numberstring

The phone number of the member.

instagram_handlestring

The instagram handle of the member.

last_purchase_datestring

The last purchase made by a member.

lifetime_points_redeemedinteger

The total points redeemed from a member's account since he joined the program.

preferred_languagestring

The preferred language of the member.

number_of_purchasesinteger

The number of purchases made by a member.

number_of_redemptionsinteger

The number of redemptions made by a member.

birthdatestring

Birthdate of the loyalty member. Expected date format: MM/DD/YYYY or MM/DD Irrespective of the year passed, 1904 will be set as a default value.

anniversary_datestring

The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD In case, where a year has not been passed the default year will be set as 1904.

enrollment_datestring

The date on which the member joined the loyalty program.

member_idstring

The unique identifier of the member defined by an Admin.

email_subscription_statusstring

The subscription status of the email. If ‘unsubscribed’, the member will not receive any email notifications triggered by Zinrelo. Default value is ‘subscribed’.

Example response

{
  "last_name": "Doe",
  "twitter_handle": "www.twitter.com/john",
  "lifetime_points_expired": 893,
  "last_modified_date": "07/14/2023 11:11:04",
  "available_points": 0,
  "pending_points": 200,
  "lifetime_points_earned": 893,
  "referral_URL": "https://www.zinrelo.com/ref/JOH30AOQ",
  "member_status": "active",
  "referral_code": "JOHL30AOQ",
  "email_address": "johndoe@gmail.com",
  "id": "64898298c7f196000b000091",
  "first_name": "John",
  "member_tags": [
    "memberretrieve",
    "retrievedmember"
  ],
  "tier_info": {
    "current_period_start": "04/01/2023",
    "loyalty_tier_name": "Silver",
    "loyalty_tier_id": "zrl_silver",
    "current_period_end": "04/01/2024",
    "qualified_points": 793
  },
  "first_purchase_date": "06/14/2023",
  "lifetime_points_deducted": 0,
  "phone_number": "+1-65070177596",
  "points_expiration_schedule": [
    {
      "expiration_date": "5-Mar-2024  00:00:00",
      "points": 101
    }
  ],
  "instagram_handle": "www.instagram.com/john",
  "address": {
    "city": "Superior",
    "country": "US",
    "line2": "",
    "line1": "1000 S. McCaslin Blvd., Suite 301",
    "state": "CO",
    "postal_code": ""
  },
  "last_purchase_date": "06/29/2023",
  "lifetime_points_redeemed": 0,
  "preferred_language": "english",
  "number_of_purchases": 2,
  "number_of_redemptions": 0,
  "birthdate": "01/31/1900",
  "anniversary_date": "07/07/2021",
  "enrollment_date": "06/14/2023 09:04:24",
  "member_id": "greatMRT040401",
  "email_subscription_status": "subscribed"
}