Users > Me

The following endpoints retrieve data about the currently authenticated user.

Current user data

get
/users/me

Retrieves data about the authenticated user. Refer to the cols[] parameter accepted values to get more information about the currently authenticated user.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
includeInvitedOrgbooleanOptional

Set this parameter to true if you want to get also the user roles in organizations with pending invitation. The default value is false.

Example: {"value":true}
colsstring[]Optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["id","name","email","language","timezoneId","localeId","countryId","features","avatar","timezone","locale","emailNotifications","usersAdminsRoleId","userOrganizationRoles","userTeamRoles","forceSetPassword","hasPassword","tfaEnabled","isAffiliatePartner","hasAddedApp","supportEligible"]}
Responses
200

Successful response

application/json
get
/users/me
200

Successful response

Current user authorization

get
/users/me/current-authorization

Returns current authorization information for the authenticated user including scope and authentication method used.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Responses
200

Successful response

application/json
get
/users/me/current-authorization
200

Successful response

User Organization invitations

get
/users/me/organization-invitations

Retrieves organization invitations of the currently authenticated user.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Responses
200

Successful response

application/json
get
/users/me/organization-invitations
200

Successful response

Last updated