List or look up loyalty members

Retrieve the loyalty cards of your organization, or find one card by phone, email or card code.

Endpoint

GET
/loyalty-members

Query parameters

NameTypeRequiredDescription
organization_idnumberNoID of your organization. Required when you use lookup or search (without it they are ignored). Results are always filtered to the API key's organization.
lookupstringNoExact card code or referral code, email, or phone number
searchstringNoPartial search on contact name, email, phone (4+ digits) or card code
program_idnumberNoOnly cards of this program
contact_idnumberNoOnly cards of this contact
statusstringNoactive or blocked
tier_idnumberNoOnly cards in this tier
$limitnumberNoNumber of cards to return (default: 10, max: 50)
$skipnumberNoNumber of cards to skip (for pagination)
$sortobjectNoSort criteria, e.g. $sort[last_activity_at]=-1 or $sort[balance]=-1

Request

Find a card at the counter (lookup)

lookup matches, in this order:

  1. The exact card code (member_code) or referral code (case and spaces are ignored).
  2. An email address (exact match on the contact email) when the value contains @.
  3. A phone number (at least 6 digits), with or without the country code.

A contact can have one card per program, so a lookup can return several cards when the organization has several programs. Add program_id to get only the card of one program.

List and search

Response

json

Each item contains every field of the Loyalty Member object (the example above is shortened). When nothing matches, data is an empty list.

When both lookup and search are sent, only lookup is used.

Report an issue with this documentation

Please log in to report issues with our documentation.