DocsICP FilingConsole
Documentation
Home Page Qoder CN Series Developer Reference API references Open APIs Manage enterprises and users Users GetUser - User information

GetUser - User information

Updated at:
Copy as MD
Product
My Favorites

Use this API to retrieve user information.

Important

The new Qoder CN documentation site is now available. Content on this site may not reflect the latest product features and changes. Visit docs.qoder.cn for the latest product documentation.

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 id

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users/029844f4-46cb-47b0-9db4-06c68eaf****' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

By username

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users/doc-test1' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Request headers

x-yunxiao-token string (Required)

The access token. See Access token for details.

Example: pt-0fh3****0fbG_35af****0484.

Request parameters

idOrUsername string (required)

The user ID or login name.

Provide one of these identifiers.

Response parameters

Sample response

{
    "id": "029844f4-46cb-47b0-9db4-06c68eaf****",
    "username": "doc-test1",
    "name": "Document Test User 1",
    "nickName": "Nickname 1",
    "email": "doc-test1@example.com",
    "staffId": "1",
    "lastOrganization": "c7655445-143f-4466-9724-8b371a21****",
    "createdAt": "2025-06-13T05:41:36Z"
}

id string

The user ID.

username string

The login name.

name string

The display name.

nickName string

The nickname.

email string

The email address.

staffId string

The employee ID.

lastOrganization string

The last login organization.

createdAt string

The time when the user was created.

Error codes

For more information, see Error code center.

Previous：CreateUser - Create userNext：UpdateUser - Update a user