Me

Retrieve Me

GET

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.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional

Information about a currently logged in user.

You can call the RetrieveMe API to gather information about the current user.

GET
$curl /api/data/me \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "links": {
14      "project": "project",
15      "workSpaceApi": "workSpaceApi"
16    },
17    "emailAddress": "emailAddress",
18    "id": "id",
19    "fullName": "fullName",
20    "workSpaceName": "workSpaceName",
21    "roleName": "roleName",
22    "isGlobalAdmin": true,
23    "isAccountAdministrator": true
24  }
25}
Built with