Query a Specific User Group
Query the detailed information of a specific user group.
Request URL
GET {base_url}/services/openapi/v1.0/user/group_detail/{groupId}
Request parameters
Path parameter
Parameter | Required | Type | Description |
---|---|---|---|
groupId | Yes | Long | User group ID. Note: You can query the
user group ID using the Query Multiple User Groups
interface. |
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 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 the information of a specific user group (ID:
1000203
).GET /services/openapi/v1.0/user/group_detail/1000203 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZjc3NTg4OC1mM2QwLTRkNDMtODJiYy00NjQ4NWZjYTY0MzIiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTkwNTE3MCwiZXhwX2luIjo4NjQwMH0.QULcMVk5CJWNnZFrHp2TYH-P1cdvPoFn4jYYEwSs0Ps
Response
exampleHTTP/1.1 200 OK
{
"data": {
"groupId": 1000203,
"groupName": "Marketing"
},
"status": "Success",
"requestId": "738d7d8ba295f1febf83d9fb5e22a865"
}