Skip to content

Data api users get

Takatsugu Shigeta edited this page Oct 29, 2021 · 3 revisions

Users: get

Retrieve a single user by its ID.

Authorization is required if you want to retrieve private properties.

Request

HTTP Request

This method accepts GET only.

GET https://your-host/your-mt-api.cgi/v1/users/{user_id}

Parameters

Method Parameters

Parameter Type Description
user_id unsigned integer The user ID or the word 'me'.

Query Parameters

Parameter Type Description
fields string This is an optional parameter. The field list to retrieve as part of the Users resource. This list should be separated by comma. If this parameter is not specified, All fields will be returned.

Request Body

Do not supply a request body.

Response

If successful, this method will return an Users resource as the response body.

Status Code

Code Description
200 no error
403 Do not have permission to retrieve the requested user.
404 User not found
Clone this wiki locally