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

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

Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher. 

 

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator/Publisher e-mail address.
X-Auth-Password (required)Administrator/Publisher password.
X-Organization-Id (optional)List of groups in the specified organization.

Organization Administrators can get the list of groups only within their own organization.

If the specified organization is not found, you will get the list of all groups in the response. As for Publishers and Organization Administrators, they will get the list of groups within their own organization in this case.

After the request has been completed, the system returns the response with Code 200. The body of the response contains an xml file with information about the groups.

 

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully.

 

Sample Request

 

Sample Response

  •