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

You can get a list of groups by sending the GET request to the following URL: /group.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators or users with a role with custom settings

Request Headers

Parameter

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 OwnerAdministratorsDepartment Administrators or a user with a role with custom settings. 
X-Auth-Password (required)The login of Account OwnerAdministratorsDepartment Administrators or a user with a role with custom settings. 

After the request has been completed, the system returns the response with the 200 code. The response code contains XML info on the groups.

Response Codes

Code

Text

Description

200Successful operation

The request was successfully processed.

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