Query Multiple User Groups
Query the basic information of user groups in bulk.
Request URL
GET {base_url}/services/openapi/v1.0/user/group_list?{query parameters}
Request parameters
Query parameters
Parameter | Required | Type | Description |
---|---|---|---|
pageSize | No | Integer | Define how many records per page. |
pageNo | No | Integer | Define which page is displayed. |
groupName | No | String | Search the user group by group name. |
Response parameters
Parameter | Type | Description |
---|---|---|
data | Object <Details> | The detailed information |
status | String | The result of the request.
|
requestId | String | The ID of the request, which can be used to quickly locate the request. |
- Details
-
Parameter Type Description pageSize Integer How many records are displayed per page. pageNo Integer Which page is displayed. total Long The total number of records. list Array <Group_Info> The list of information. Group_InfoParameter Type Description groupId Long User group ID. groupName String User group name. Note: The All Users group on Yeastar Workplace is returned with the company name.
Example
Request example
Query multiple user groups:
- Display 2 records per page.
- Display Page 1.
GET /services/openapi/v1.0/user/group_list?pageSize=2&pageNo=1 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiZTc0ZGY0OS1hNjdmLTQ2NzMtYTkzMi1iMzY3YWY4NDM5ZjYiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY5MDE4MTA0NCwiZXhwX2luIjo5OTk5OTk5OTl9.rKahurP85PjeJOhVTtGsenUOcjXL-3z6ERFpU4a_ZV0GET /services/openapi/v1.0/user/group_list HTTP/1.1
Response
exampleHTTP/1.1 200 OK
{
"data": {
"pageSize": 2,
"pageNo": 1,
"total": 4,
"list": [
{
"groupId": 1000203,
"groupName": "Marketing"
},
{
"groupId": 1000202,
"groupName": "Tech Support"
}
]
},
"status": "Success",
"requestId": "ded735220aa56fa14ee01a1c1fc81d1b"
}