Skip to content

Lookup User

Lee Sambridge edited this page May 29, 2024 · 15 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 of members details
    HTTP - 404 - Either the email address or the Partner User Id used could not be found

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

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

A typical response would be:

{
    "id": 15006401,
    "joinDate": "2023-12-06",
    "memberURL": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "memberLevel": "Basic",
    "lastName": "LastName",
    "status": "Active",
    "firstName": "FirstName",
    "emailAddress": "newone@test.com"
}

Lookup user by Id

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

HTTP Response Values

    HTTP - 200 - Successful lookup of members details
    HTTP - 404 - Either the email address or the Partner User Id used could not be found

[GET] /v2/users/userId

Route Parameter Description
userId User's Id

A typical response would be:

{
    "id": 15006401,
    "joinDate": "2023-12-06",
    "memberURL": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "memberLevel": "Basic",
    "lastName": "LastName",
    "status": "Active",
    "firstName": "FirstName",
    "emailAddress": "newone@test.com"
}

Clone this wiki locally