Get a User by Email Address

Returns the details of a user (including custom fields) based on the Email Address.

Pass the “EmailAddress” in the API URL. You’ll get an empty (square brackets []) response if –

  • You pass the “EmailAddress” of an inactive user.
  • The user doesn’t exist.


Copy URL

URL Parameters

Parameter Description
EmailAddress User's Email Address.


200 OK

Content-Type: application/json

	"CompanyName":"Education 101",
	"ManagerName":"Bob Doe",
	"TeamName":"Education 101"

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.