Retrieves the details of a specified member, such as email, roles, departments, and status.
Endpoint and authorization information
Get the endpoint: Replace {domain} in the API request syntax.
Product | Resource | Required permission |
Organization management | Organization members | Read-only |
Request syntax
Region edition
GET https://{domain}/oapi/v1/platform/members/{id}Request header
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | Personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Location | Required | Description | Example |
id | string | path | Yes | Organization member ID. |
Request examples
Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/members/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
| - | object | ||
deptIds | array[string] | Department IDs. | ["99d1****6124"] |
string | Email address. | example@example.com | |
id | string | Member ID. | 99d1****6124 |
joined | string | Join time. | 2023-08-31T03:59:16.201Z |
lastUpdated | string | Last update time, equal to the database update time. | 2023-08-31T03:59:16.201Z |
name | string | Member name. | ExampleName |
nickName | string | Nickname. | John |
organizationId | string | Organization ID. | 99d1****6124 |
roleIds | array[string] | Role IDs. | ["99d1****6124"] |
staffId | string | Employee ID. | E001 |
status | string | Member status. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, and UNVISITED. | ENABLED |
userId | string | User ID. | 99d1****6124 |
username | string | Username. Format: xxx_{organization identifier}. | zhangsan_org1 |
visited | string | Last access time. | 2023-08-31T03:59:16.201Z |
Response examples
{
"deptIds": ["99d1****6124"],
"email": "example@example.com",
"id": "99d1****6124",
"joined": "2023-08-31T03:59:16.201Z",
"lastUpdated": "2023-08-31T03:59:16.201Z",
"name": "ExampleName",
"nickName": "John",
"organizationId": "99d1****6124",
"roleIds": ["99d1****6124"],
"staffId": "E001",
"status": "ENABLED",
"userId": "99d1****6124",
"username": "zhangsan_org1",
"visited": "2023-08-31T03:59:16.201Z"
}Error codes
API error codes are listed in the Error Code Center.