All Products
Search

This Product

    :List members

    Document Center

    :List members

    Last Updated:Mar 27, 2026

    Retrieves a list of organization members 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 settings

    organization members

    read-only

    Request syntax

    GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members

    Request

    Query the member list

    curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4/members?page=1&perPage=100' \
  -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

    organizationId string (Required)

    The ID of the organization. You can find this ID on the Basic Information page in organization settings.

    page integer (Optional) Default: 1

    The page number.

    perPage integer (Optional) Default: 100

    The number of entries to return on each page. Valid values: [1, 100].

    Response parameters

    Response example

    [
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "name": "Example Name",
        "email": "example@example.com",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED",
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]

    deptIds array[string]

    The IDs of the departments to which the member belongs.

    id string

    The ID of the member.

    joinedstring

    The timestamp when the member joined the organization. This value is the record's creation time in the database.

    name string

    The name of the member.

    email string

    The email address of the member.

    organizationIdstring

    The ID of the organization.

    roleIdsarray[string]

    The IDs of the roles assigned to the member.

    statusstring

    The status of the member.

    Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, and UNVISITED.

    userIdstring

    The ID of the user.

    visitedstring

    The timestamp of the member's last visit.

    Response headers

    Parameter

    Description

    Example

    x-next-page

    The next page number.

    1

    x-page

    The current page number.

    2

    x-per-page

    The number of entries per page.

    1

    x-prev-page

    The previous page number.

    2

    x-total

    The total number of entries.

    1

    x-total-pages

    The total number of pages.

    3

    Error codes

    For more information, see Error codes.