Page tree
Skip to end of metadata
Go to start of metadata

Request: GET /group

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

Request Headers

Header

Description

X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com.
X-Auth-Email (required)The login of Account OwnerAccount AdministratorsDepartment Administrators, or a user with a custom role. 
X-Auth-Password (required)The password of Account OwnerAccount AdministratorsDepartment Administrators, or a user with a custom role. 

Response Codes

Code

Text

Description

200Successful operation

The request was successfully processed. The response code contains XML info on the groups.

400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission Denied

The user doesn't have enough permissions to get the list of groups.

Sample Request

GET /group HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

Sample Response

HTTP/1.1 200 Successful operation
Connection: close

<?xml version="1.0"?>
<response>
    <group>
        <groupId>d3dce128-ae3d-11e9-aa19-2e820d27258c</groupId>
        <name>Active Sales</name>
        <isSmart>false</isSmart>
    </group>
    <group>
        <groupId>e0df6e34-a95d-11e9-a6f1-72515768dba2</groupId>
        <name>Business Services</name>э
        <isSmart>false</isSmart>
    </group>
    <group>
        <groupId>7de5b784-af0c-11e9-82a9-6ee5008c8f90</groupId>
        <name>Cold Calling</name>
        <isSmart>true</isSmart>
    </group>
</response>
  • No labels