API ReferenceMe

Retrieve Me

Retrieve information about the currently logged on user. This API call will always succeed with a 200 OK if called with valid authentication information. If the authentication information provided is not valid, calling this API will return a 401 Authentication Failed error message. If successful, this API returns information about the user including its home URL, email address, user name, and workspace name.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeobject or null
The HTTP code of the response.
dataobject or null
Information about a currently logged in user. You can call the RetrieveMe API to gather information about the current user.