Request: GET /group/{group_id}

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 AdministratorDepartment Administrator, or a user with a role with custom settings. 
X-Auth-Password (required)The password of Account OwnerAccount AdministratorDepartment Administrator, or a user with a role with custom settings. 
ParameterDescription
group_id (required)The ID of a group you would like to get info on.

Response Codes

Code

Text

Description

200Successful operation

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

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

The user doesn't have enough permissions to get information on the group.

Sample Request

GET /group/b1496214-acab-11e9-8db0-120a62f268a9 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://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" encoding="UTF-8"?>
<response>
    <group>
        <usersCount>1</usersCount>
        <userIds/>
        <groupId>6b2d3e10-e043-11e9-8511-0a580af40b37</groupId>
        <name>New Hires</name>
        <isSmart>0</isSmart>
    </group>
</response>