The 'Get User Status' endpoint is used to get the status of a specific user account in TeamTracks.
Get User Status
The following GET endpoint returns the status of a user account given the email address:
https://api.team-tracks.com/user/status/{email}
Making a GET request to the above URL should return a 200 OK response (on success) with a JSON object including a status code and status description.
An example of the response body is shown below when a user account exists and is enabled for a given email address:
{
"status": "Active",
"statusCode": 0
}
The important properties in the response are outlined below,
Property | Description |
---|---|
status | A short description of statusCode, only to be used when testing |
statusCode | A number representing the status of the user account. The three possible values are: 0 = Account exists and is enabled 1 = Account exists and is disabled 2 = Account does not exist |