Get a user

Returns the details of a user on Mindtickle by Mindtickle user ID.

View as Markdown

Prerequisites

Authentication and setup: A valid access token.
Create a user: The user must exist.

Endpoint

GET /services/data/v4.0/mtobjects/User/USER_ID

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN.

Path parameters

Parameter	Type	Required	Description
`USER_ID`	string	Required	Mindtickle ID of the user.

Request

This endpoint has no request body.

Response

Field	Type	Description
`requestId`	string or null	Request identifier. The response examples return `null`.
`responseCode`	integer	Special response codes from the server.
`responseType`	string	Type of response from the server.
`taskCompleted`	boolean	Completion flag for this request. This endpoint returns its result directly.
`user`	User	The requested user object.
`user.name`	string	Name of the user.
`user.username`	string	Username of the user when UID is enabled for your Mindtickle instance, and the email address when UID is not enabled.
`user.timezone`	string	Time zone of the user.
`user.id`	string	Mindtickle ID of the user.
`user.email`	string or null	Applicable only if UID is enabled for your Mindtickle instance.
`user.userState`	string	Current state of the user: Active, Added, or Deactivated.
`user.profile`	AttributeMap	Mindtickle profile fields information.
`user.groupIds`	Array[string]	IDs of the groups that the user belongs to.
`user.seriesEntities`	Array[SeriesEntity]	Series that the user is invited to.
`user.source`	string	The system mechanism used to provision the user. Possible values include `_default` (REST API), `okta` (Okta SCIM), and `AzureAD` (Azure AD SCIM).
`user.managers`	Array[Manager]	Information on the managers assigned to the user.

Response example

{
  "requestId": null,
  "responseCode": 0,
  "responseType": "USER",
  "taskCompleted": true,
  "user": {
    "name": "Alex Fry",
    "username": "alex.fry@example.com",
    "timezone": "America/Costa_Rica",
    "id": "123456789abcd101",
    "email": null,
    "userState": "ADDED",
    "profile": {},
    "groupIds": [],
    "seriesEntities": [],
    "source": "_default",
    "managers": []
  }
}