Lookup User

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 (the response body text is ```400- NOT OK```)

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

Query String Parameter	Description
emailAddress	User's email address
memberId	Your unique identifier for this user (the PartnerMemberId) - takes precedence over emailAddress if both are supplied

A typical response would be:

{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2023-12-06",
    "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": "newone@test.com",
    "Identifier": 15006401,
    "ExternalMemberId": "your-identifier",
    "OrgUnits": null,
    "Action": null
}

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
    400 - The identifier is not greater than zero
    404 - The identifier for the user could not be found (the response body text is ```400- NOT OK```)

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

Route Parameter	Description
identifier	User's Id

A typical response would be (this endpoint does not return ExternalMemberId):

{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2023-12-06",
    "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": "newone@test.com",
    "Identifier": 15006401,
    "ExternalMemberId": null,
    "OrgUnits": null,
    "Action": null
}