Skip to content

Lookup User Levels

Lee Sambridge edited this page May 29, 2024 · 12 revisions

Lookup user

Use the following endpoint and form fields to retrieve information related to a specific user. Either an EmailAddress or PartnerMemberId must be specified to identify the user that is being looked up.

HTTP Response Values

    HTTP - 200 - Successful lookup and find of members details
    HTTP - 404 - No members found with the search criteria
    HTTP - 400 - Page size too large

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

Route Parameter Description
level Acceptable values are: Basic, Basic Plus, Premium, Premium Plus
Query String Parameter Description
page Optional - defaults to 0
pageSize Optional - defaults to 100, maximum page size 1000
Status Optional - Active, Inactive, Cancelled, defaults all statuses

A typical response would be:

[
{
    "RenewalDate": "2024-12-05",
    "API": "Members",
    "JoinDate": "2023-12-06",
    "Identifier": 8791480,
    "loginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "level": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "newone@test.com",
    "country": "UK",
    "partnerMemberId": "your-identifier"
},
{
    "RenewalDate": "2024-12-05",
    "API": "Members",
    "JoinDate": "2023-12-06",
    "Identifier": 8791480,
    "loginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "level": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "newone@test.com",
    "country": "UK",
    "partnerMemberId": "your-identifier"
}
]

Clone this wiki locally