Search for organization members using OpenAPI.

Endpoint and Authorization Information

Get the endpoint to replace the `{domain}` parameter in the API request syntax.
Get a personal access token.

Product	Resource	Required Permission
Organization Management	Organization Members	Read-only

Request Syntax

POST https://{domain}/oapi/v1/platform/organizations/members:search

Request Headers

Parameter	Type	Required	Description	Example Value
x-yunxiao-token	string	Yes	Personal access token.	pt-0fh3**0fbG_35af**0484

Request Parameters

Parameter	Type	Location	Required	Description	Example Value
-	object	body	No
deptIds	array[string]	body	No	List of department IDs. Empty by default.	["99d1****6124"]
includeChildren	boolean	body	No	[Not applicable for Standard Edition] Whether to include child departments. Default is false (excluded). This field has no effect when deptIds is empty.	false
nextToken	string	body	No
page	integer	body	No	Page number, starting from 1. Default is 1.	1
perPage	integer	body	No	1<=perPage<=100. Default is 100.	100
query	string	body	No	Query parameter.	phw
roleIds	array[string]	body	No	List of role IDs. Empty by default.	["99d1****6124"]
statuses	array[string]	body	No	Filter members by status. By default, returns only ENABLED members. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, UNVISITED. ENABLED = NORMAL_USING + UNVISITED; UNDELETED = ENABLED + DISABLED.	["ENABLED"]

Request Examples

curl -X 'POST' \
  'https://{domain}/oapi/v1/platform/organizations/members:search' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "deptIds": ["99d1****6124"],
        "includeChildren": false,
        "nextToken": "",
        "page": 1,
        "perPage": 100,
        "query": "phw",
        "roleIds": ["99d1****6124"],
        "statuses": ["ENABLED"]
    }'

Response Parameters

Parameter	Type	Description	Example Value
-	array
-	object
deptIds	array[string]	List of department IDs in the organization.	["99d1****6124"]
email	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, which equals the database update time.	2023-08-31T03:59:16.201Z
name	string	Member name.	Example Name
organizationId	string	Organization ID.	99d1****6124
roleIds	array[string]	Role information.	["99d1****6124"]
status	string	Member status. Valid values: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, UNVISITED.	ENABLED
userId	string	User ID.	99d1****6124
visited	string	Last visit time.	2023-08-31T03:59:16.201Z

Response Example

[
    {
        "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": "Example Name",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED",
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]

Response Headers

Parameter	Description	Example Value
x-next-page	Next page.
x-page	Current page.
x-per-page	Number of items per page.
x-prev-page	Previous page.
x-total	Total data volume.
x-total-pages	Total number of pages.

Error Codes

For more information about API-related error codes, see the Error Code Center.