GET /api/v1/groups/{group_id}
Get information about a given group.
Returns :
_id
: group’s idname
: group’s namepublic
: the group’s privacyusers
: array of the users enrolled in the groupcoaches
: array of the coaches for the groupadmins
: array of admins for the groupauthors
: array of authors for the groupcustom
: optional. Custom information for the group
Changelog :
- Milestone S (February 20): added admins and authors in the response
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
group_id |
String | Yes |
group's id |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.