List Members

get

https://api.zinrelo.com/v2/loyalty/members

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The API Rate Limiting Category is General API. This API endpoint returns a list of all members. By default, the members are returned sorted by enrolment_date, with the most recent members appearing first.

You can also pass in custom attributes to list down all the members associated with Zinrelo. You will first need to define the custom member attributes and then use the internal IDs in the API to pass the data.

If custom member attributes are Text, Text Area, Dropdown, then key value will be “custom_attributes”= {“eq”, “neq”, “contains”, “does_not_contain”} For example: Replace custom_attribute_name with any attributes like “tag”= {“eq”: “purchase”}
If custom member attribute is Date, then key value will be “custom_attributes” = { “eq”, “gt”, “gte”, “lt”, “lte”, “between”} For example: Replace custom_attribute_name with any attributes like “birthdate”= {“eq”: “08/26/1989”}
If custom member attribute is Multiselect, then key value will be “custom_attributes” = {“contain_all_of”, “contain_any_of”, “contain_none_of”} For example: Replace custom_attribute_name with any attributes like “tier”= {“contain_all_of”: “gold”}
If the custom member attribute type is Number, then key value will be “custom_attributes” = {“lt”, “lte”, “gt”, “gte”, “eq”, “neq”, “between”} For example: Replace custom_attribute_name with any attributes like "awarded_points"= {“eq”: “1000”}

📘
This is the latest version of the List Members API. If you are still using the older version, click here.

Query Params

start_cursor

string

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.

count

int32

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_date

string

Defaults to {"gt":"01/21/2022"}

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_date

string

Defaults to {"lt":"01/21/2022"}

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_status

string

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

member_tags

array of strings

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"}

member_tags

language

string

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

Responses

This is the latest version of the List Members API. If you are still using the older version, click here.

200200

400400