Groups
The following requests relate to getting information regarding the academy's groups via the Schoox Academy API. Note: All requests must be Authenticated.
List of Groups
Returns a list of all academy groups
GET /groups
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| start | Starting Position | No | Integer | 0 |
| limit | Number of courses to return per request, up to maximum of 20. Default to 20 | No | Integer | 20 |
Example Request
https://api.schoox.com/v1/groups?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
{"groups":[{"groupId":84479,"title":"API Academy (test) Support Group","description":"This group is to support Academy employees on how to use Schoox. Group members can start discussions, ask questions and share their experience and knowledge.","dateAdd":{"date":"2021-11-30 10:05:24.000000","timezone_type":3,"timezone":"UTC"},"modifiedAt":{"date":"2022-07-12 15:30:23.000000","timezone_type":3,"timezone":"UTC"},"visible":1,"public":1,"enabled":1,"code":null,"category":-1,"thumb":"Academy_Support_Group_image.jpg","cover":null,"discussions":0,"members":1,"owner":1660967137,"content":1,"wall":null,"institutionId":226581108,"visibleD":1,"visibleDB":1,"introduction":"","approval":null,"discussionEdit":true,"wallEdit":true,"academyAdmin":null,"openTo":null}]}
Associate user with group
Associates a list of users to a group. Max 10 users per request
PUT /groups/:groupid/associate
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
Example Request
https://api.schoox.com/v1/groups/84479/associate?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Request Object
Show All
{"user_ids":[1,2,3,4]}