Use this API to retrieve user information.
|
Supported editions |
Enterprise Dedicated Edition |
Service endpoints
Get the service endpoint and replace {domain}
in the API request syntax with your
endpoint
.
Authorization
Product | Resource | Required permission |
organization settings | user | read-only |
Request syntax
GET https://{domain}/oapi/v1/platform/users/{idOrUsername}Request | By |
Request headers | |
The access token. See Access token for details. Example: pt-0fh3****0fbG_35af****0484. | |
Request parameters | |
idOrUsername The user ID or login name. Provide one of these identifiers. |
Response parameters | Sample response |
id The user ID. | |
username The login name. | |
name The display name. | |
nickName The nickname. | |
email The email address. | |
staffId The employee ID. | |
lastOrganization The last login organization. | |
createdAt The time when the user was created. |
Error codes
For more information, see Error codes.