Skip to content

Lookup User Levels

lsambridge edited this page Oct 6, 2026 · 12 revisions

Lookup users by level

Use the following endpoint and query string parameters to fetch all users at the specified level.

HTTP Response Values

    200 - Successful lookup of members details
    400 - Page size too large
    404 - No users were found for the level/status specified (the response body text is ```400- NOT OK```)

[GET] /v2/users/{{level}}/level

Route Parameter Description
level Acceptable values are: Basic, BasicPlus, Premium, PremiumPlus (not case sensitive, no spaces)
Query String Parameter Description
page Optional - defaults to 0
pageSize Optional - defaults to 100, maximum page size 1000
status Optional - Active, Cancelled, defaults to all statuses

A typical response would be:

[{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2026-05-27",
    "LoginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "HubLoginUrl": "https://landing.myezrewards.com/client/default/?iframe=ffe2SLrm4qrvyulsci",
    "Level": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "test@ez-loyalty.com",
    "Identifier": 15140131,
    "ExternalMemberId": "your-identifier",
    "OrgUnits": null,
    "Action": null
},
{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2026-05-27",
    "LoginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "HubLoginUrl": "https://landing.myezrewards.com/client/default/?iframe=ffe2SLrm4qrvyulsci",
    "Level": "Basic",
    "LastName": "LastName",
    "Status": "Cancelled",
    "FirstName": "FirstName",
    "EmailAddress": "test2@ez-loyalty.com_cancelled",
    "Identifier": 15140132,
    "ExternalMemberId": "your-identifier",
    "OrgUnits": null,
    "Action": null
}]

Clone this wiki locally