AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: GET /groups
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or a custom role.
Header | Description |
---|
Authorization (required) | Access token. You can obtain a token by making a request.
|
pageSize (optional) | The number of entries per page. If not indicated, equal to 1000. |
pageToken (optional) | The token to continue to the next page. It returns if the number of groups is more than pageSize. You can send a second request with this parameter and receive information on the next groups. |
Response Codes
Code | Text | Description |
---|
200 | OK | The request has been successfully processed. The response body contains the XML data regarding groups. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission Denied | The user doesn't have enough permissions to retrieve a list of groups. |
Sample Request
GET /groups?pageSize=1&pageToken=MmFhNmM1ZDItZmE1MS0xMWU5LWIzYmYtMGE1ODBhZjQwYTgz https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
XML
Sample Response
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<groups>
<group>
<groupId>84855bf6-06ac-11ea-9eea-0a580af40786</groupId>
<name>string</name>
<isSmart>0</isSmart>
</group>
<group>
...
</group>
</groups>
<nextPageToken>string</nextPageToken>
</response>
XML