Query organization member list_Lingma_AI Coding Assistant - AI Coding Assistant Lingma

Call this API to query the list of members.

Supported editions

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
Organization settings	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	The access token.	pt-0fh3**0fbG_35af**0484

Request parameters

Parameter	Type	Position	Required	Description	Sample value
`organizationId`	string	path	Yes	The ID of the organization.	99d1****71d4
`page`	integer	query	No	The page number. Default value: 1.	1
`perPage`	integer	query	No	The number of entries per page. Default value: 100.	100

Sample request

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/members
  -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]	The list of organization departments to which the member belongs.	["99d1****6124"]
`id`	string	The ID of the member.	99d1****6124
`joined`	string	The date and time when the member joined. Same as the creation time in the database.	2023-08-31T03:59:16.201Z
`name`	string	The name of the member.	Example Name
`organizationId`	string	The ID of the organization.	99d1****6124
`roleIds`	array[string]	The roles of the member.	["99d1****6124"]
`status`	string	The status of the member. Valid values: `ENABLED` `DISABLED` `UNDELETED` `DELETED` `NORMAL_USING` `UNVISITED` `ENABLED` means `NORMAL_USING`+`UNVISITED`. `UNDELETED` means `ENABLED`+`DISABLED`.	ENABLED
`userId`	string	The ID of the user.	99d1****6124
`visited`	string	The last visit time.	2023-08-31T03:59:16.201Z

Sample success responses

[
    {
        "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`	The next page.	1
`x-page`	The current page.	2
`x-per-page`	The number of entries per page.	1
`x-prev-page`	The previous page.	2
`x-total`	The total number of entries.	1
`x-total-pages`	The total number of pages.	1

Error codes

For more information, see Error codes.