v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

List Members

get/members

Query parameters

start_cursorstring

For the first request, you do not need to send the start_cursor in the request param. The start cursor value will be populated in the response of the API call. You can use that value to fetch the next pages. Please Note: This cursor is valid for next 5 minutes.

countinteger

Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.

enrolment_datestring

This can be used to filter the list of members based on their enrolment_date. Child parameters are: To filter dates 'equal to' a particular date, use operator "eq". Example: enrolment_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: enrolment_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: enrolment_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: enrolment_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: enrolment_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: enrolment_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

last_modified_datestring

This can be used to filter the list of members based on their last_modified date. Child parameters are: To filter dates 'equal to' a particular date, use operator "eq". Example: last_modified_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: last_modified_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: last_modified_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: last_modified_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: last_modified_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: last_modified_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

member_statusstring

Defaults to “active”. The other acceptable values are “blocked” and “opted_out”.

member_tagsstring[]

This can be used to filter the list of members based on the values they are tagged with. Child parameters are: contain_all_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains all the passed values in their member tags list. Example: {"contain_all_of":"active"} contain_any_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains at least one of the passed values. Example: {"contain_any_of":"active"} contain_none_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains none of the passed values. Example: {"contain_none_of":"active"}

languagestring

One of the store languages, for example english/ italian/ german, etc.

Response

200

totalinteger

The total number of transactions.

next_cursorstring

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.

moreboolean

Example response

{
  "total": 48,
  "next_cursor": "eyJzZWFyY2hfYWZ0ZXIiOiBbMTY3NDY0MzQzNjY2NV0sICJzdGFydF9pbmRleCI6IDJ9",
  "members": [
    {
      "last_name": "Doe",
      "twitter_handle": "www.twitter.com/john",
      "revenue": 0,
      "lifetime_points_expired": 0,
      "last_modified_date": "2023-02-07T06:00:05.345Z",
      "available_points": 10000,
      "lifetime_points_earned": 10000,
      "referral_URL": "https://zinrelo.com/ref/JOH4N54C",
      "member_status": "active",
      "email_address": "johndoe@gmail.com",
      "id": "63e1e8e47d5790000dc0c81b",
      "first_name": "John",
      "member_tags": [
        "memberadded",
        "membercreated"
      ],
      "referrer_code": "ANA855D6",
      "tier_info": {
        "tier_qualification_units": 1000,
        "current_period_start": "03/01/2022",
        "loyalty_tier_name": "Silver",
        "loyalty_tier_id": "zrl_silver",
        "current_period_end": "02/28/2023",
        "qualified_points": 0
      },
      "custom_attributes": {
        "City_Name": "Paris",
        "Marital_Status": "Married",
        "Income_Source": "Service",
        "Age_In_Years": "37",
        "Gender_Identity": "Male",
        "Graduation_Date": "15/12/1989 00:00:00"
      },
      "first_purchase_date": "12/12/2021",
      "lifetime_points_deducted": 0,
      "phone_number": "+1-65070177596",
      "instagram_handle": "www.instagram.com/john",
      "referrer_name": "Anna Scott",
      "address": {
        "city": "Palo Alto",
        "country": "US",
        "line2": "537 Lytton Ave",
        "line1": "Suite #200",
        "state": "CA",
        "postal_code": "94307"
      },
      "last_purchase_date": "12/02/2022",
      "lifetime_points_redeemed": 0,
      "preferred_language": "English",
      "number_of_purchases": 20,
      "number_of_redemptions": 0,
      "birthdate": "1900-08-26T00:00:00Z",
      "churn_status": "low_risk",
      "anniversary_date": "2023-02-07T06:00:04.589Z",
      "enrollment_date": "2023-02-07T06:00:04.589Z",
      "member_id": "5779678689"
    },
    {
      "last_name": "Scott",
      "twitter_handle": "www.twitter.com/anna",
      "revenue": 15002,
      "lifetime_points_expired": 0,
      "last_modified_date": "2023-01-25T11:03:55.594Z",
      "available_points": 25002,
      "lifetime_points_earned": 25002,
      "referral_URL": "https://zinrelo.com/ref/ANN1QBDY",
      "member_status": "active",
      "email_address": "annascott286@gmail.com",
      "id": "63d107ec354176000a742cd7",
      "first_name": "Anna",
      "member_tags": [
        "exit_campaign_80456"
      ],
      "referrer_code": "463278John",
      "tier_info": {
        "tier_qualification_units": 1000,
        "current_period_start": "12/03/2022",
        "loyalty_tier_name": "Platinum",
        "loyalty_tier_id": "zrl_platinum",
        "current_period_end": "02/28/2024",
        "qualified_points": 15002
      },
      "custom_attributes": {
        "traveller_name": "Anna",
        "booking_date": "02/07/2023",
        "preferences": "British Airways",
        "high_value_purchase": 10000,
        "purchase_place": "London"
      },
      "first_purchase_date": "2023-01-25T10:45:47.616Z",
      "lifetime_points_deducted": 0,
      "phone_number": "+1-6507017134",
      "instagram_handle": "www.instagram.com/anna",
      "referrer_name": "John Doe",
      "address": {
        "city": "Superior",
        "country": "US",
        "line2": "",
        "line1": "1000 S. McCaslin Blvd., Suite 301",
        "state": "CO",
        "postal_code": "15702"
      },
      "last_purchase_date": "2023-01-25T11:03:55.235Z",
      "lifetime_points_redeemed": 0,
      "preferred_language": "English",
      "number_of_purchases": 4,
      "number_of_redemptions": 0,
      "birthdate": "07/01/1997",
      "churn_status": "low_risk",
      "anniversary_date": "03/12/2022",
      "enrollment_date": "2023-01-25T10:43:56.665Z",
      "member_id": "annascott2355"
    }
  ],
  "more": true
}

All 45 operations