Request: GET /group/{group_id}
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
The Author receives information about the number of users, but does not receive their IDs.
Request Headers
Header | Description |
|---|---|
| Authorization (required) | Access token. You can obtain a token by making a request. |
| Parameter | Description |
| group_id (required) | The ID of a group you would like to get info on. |
Response Parameters
| Parameter | Description |
|---|---|
| group | An array with the group’ data. |
| usersCount | The number of users in the group. |
| groupId | The group ID. |
| userIds | An array with the users’ data. |
| id | The user’s ID. |
| name | The session’s title. |
| isSmart | The parameter shows if the group is a smart group. Possible values: 0 — The group is not a smart group. 1 — The group is a smart group. |
Response Codes
Code | Text | Description |
|---|---|---|
| 200 | OK | The request was successfully processed. The response body contains XML info on the group. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission Denied | The user doesn't have enough permissions to get information on the group. |
Sample Request
GET /group/b1496214-acab-11e9-8db0-120a62f268a9 https/1.1 Host: api-learn.ispringlearn.com Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Sample Response
https/1.1 200 OK https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<group>
<usersCount>1</usersCount>
<userIds>
<id>1250ac9a-3c12-11ed-957b-5607de77b3b8</id>
</userIds>
<groupId>6b2d3e10-e043-11e9-8511-0a580af40b37</groupId>
<name>Interns</name>
<isSmart>0</isSmart>
</group>
</response>