All Products
Search

This Product

    AI Coding Assistant Lingma:ListUsers - List users

    Document Center

    AI Coding Assistant Lingma:ListUsers - List users

    Last Updated:Mar 27, 2026

    Lists users by using OpenAPI.

    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 management

    User

    Read-only

    Request syntax

    GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}

    Request details

    Active users

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

    Deleted users

    curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users?status=deleted' \
  -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

    filter string (Optional)

    A keyword for fuzzy searches on the username, logon name, email address, or phone number.

    status string (Optional)

    Filters users by their status.

    • enabled: Returns active users.

    • deleted: Returns deleted users.

    deptId string (Optional)

    Filters users by department ID.

    page integer (Optional) Default value: 1

    The page number to return.

    perPage integer (Optional) Default value: 100

    The number of entries to return per page. The value must be in the range of [1, 100].

    Response parameters

    Active users

    [
    {
        "id": "c75d6f21-2af7-4d8e-b0fb-bac25128****",
        "username": "tmp_test2",
        "name": "Test User 2",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "lastOrganization": "3deba052-8501-4f30-a52d-3e9b1ca8****",
        "createdAt": "2025-06-10T06:45:29Z"
    },
    {
        "id": "85c7aa62-8da7-4f2d-8c99-4b90a253****",
        "username": "tmp_test1",
        "name": "Test User 1",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "createdAt": "2025-06-10T06:44:57Z"
    }
]

    Deleted users

    [
    {
        "id": "3d4caf00-0004-4a07-9cb7-18c9559d****",
        "username": "doc-test4",
        "name": "Doc Test User 4",
        "nickName": "Nickname 4",
        "email": "doc-test4@example.com",
        "staffId": "1004",
        "sysDeptIds": [
            "ebeb5a64-c98c-478a-9d9d-513841da****"
        ],
        "createdAt": "2025-06-13T05:41:53Z",
        "deletedAt": "2025-06-13T06:36:43Z"
    }
]

    id string

    The unique ID of the user.

    username string

    The login name of the user.

    name string

    The display name of the user.

    nickName string

    The nickname of the user.

    email string

    The email address of the user.

    lastOrganization string

    The ID of the organization that the user last logged on to.

    staffId string

    The employee ID of the user.

    sysDeptIds array[string]

    The IDs of the departments to which the user belongs.

    createdAt string

    The time when the user was created.

    deletedAt string

    The time when the user was deleted.

    This parameter is returned only for deleted users.

    Response headers

    Parameter

    Description

    Example value

    x-next-page

    The next page

    2

    x-page

    The current page

    1

    x-per-page

    The number of entries per page

    100

    x-prev-page

    The previous page

    0

    x-request-id

    The request ID

    37294673-00CA-5B8B-914F-A8B35511E90A

    x-total

    The total number of entries

    10

    x-total-pages

    The total number of pages

    1

    Error codes

    For more information, see Error codes.