Skip to content

Lookup User

lsambridge edited this page May 13, 2025 · 15 revisions

Lookup user

Use the following endpoint 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

    200 - Successful lookup of members details
    404 - Either the email address or the PartnerMemberId specified could not be found

[GET] /v2/users?EmailAddress={{emailAddress}}&PartnerMemberId={{ID}}

Query String Parameter Description
EmailAddress User's email address
memberId Your unique identifier for this user

A typical response would be:

{
    "identifier": 15006401,
    "joinDate": "2023-12-06",
    "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"
}

Lookup user by identifier

Use the following endpoint to retrieve information related to a specific user. identifier must be specified to identify the user that is being looked up.

HTTP Response Values

    200 - Successful lookup of members details
    404 - The identifier for the user could not be found

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

Route Parameter Description
identifier User's Id

A typical response would be:

{
    "identifier": 15006401,
    "joinDate": "2023-12-06",
    "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