Info

This is a sample API reference document targeting developers.

Get User Details

The Get User transaction is used to retrieve user details from the system.

Request

Format the request as follows:

GET https://fake.system.com/users/user={user_email}

User email is required and must be formatted as a standard email address: {string}@{string}.{string}. For example:

dennis.dufrene@yahoo.com

Request Sample

GET https://fake.system.com/users/user=dennis.dufrene@yahoo.com

Response

The system returns the following fields:

Supported Fields

Field	Description
user_email	The user’s email address.
user_name	The user’s first and last name.
user_phone	The user’s contact phone number (cell or home).
user_active	Yes or no field indicating if the user has been active in the last 30 days.

Response Sample

{
   "user_email" : "dennis.dufrene@yahoo.com",
   "user_name" : "Dennis Dufrene",
   "user_phone" : "5555555555",
   "user_active" : "Yes",
},

Error Handling

The system returns the following errors:

Error	Description
200: User Not Found	The email address included in the request is not available in the system.
231: Bad Request	The email address is blank, null, or incorrectly formatted.
260: Number of Requests Exceeded	API calls exceeded the limit of 15 in 5 second(s).
299: Server Error	Internal server error resulting from failed API call. Review stacktrace for more details.