ListMembers API - Query organization members | Lingma - Qoder CN Series

Queries the list of organization members.

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.

Applicable versions

Enterprise Dedicated Edition

Service endpoints and authorization

Get the service endpoint to replace <domain> in the API request syntax with your endpoint.
Obtain the access token.

Obtain the organizationId. Go to the Lingma console and view the organization ID on the Basic Information page under Enterprise settings > Organization.

Product	Resource	Required permission
Tennant Management	Organization members	Read-only

Request syntax

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

Request header

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

Request parameters

Parameter	Type	Position	Required	Description	Sample value
organizationId	string	path	Yes	Organization ID.	99d1****71d4
page	integer	query	No	Page number. Default: 1.	1
perPage	integer	query	No	Entries per page. Default: 100.	100

Sample request

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/members?page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter	Type	Description	Sample value
-	array
-	object
deptIds	array[string]	Departments the member belongs to.	["99d1****6124"]
id	string	Member ID.	99d1****6124
joined	string	Time when the member joined. Equivalent to the database creation time.	2023-08-31T03:59:16.201Z
name	string	Member name.	Example Name
organizationId	string	Organization ID.	99d1****6124
roleIds	array[string]	Role IDs assigned to the member.	["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

Sample response

[
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "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 header

Parameter	Description	Sample value
x-next-page	Next page number.	1
x-page	Current page number.	2
x-per-page	Entries per page.	1
x-prev-page	Previous page number.	2
x-total	Total entries.	1
x-total-pages	Total pages.	3

Error codes

For more information, see Error code center.