🔵GET groups

Fetches a list of groups setup by the organisation.

URL

GET https://training.tapintosafety.com.au/api/v2/groups

Parameters

Schema

No parameters available for this endpoint.

Example

curl https://training.tapintosafety.com.au/api/v2/groups \
    -H "Authorization: Bearer $APIKey"

Responses

200 - OK

A list of groups from the database. List may be empty if no groups have been set up.

Schema

Name	Type	Description
entities	array	The list of the groups returned.
┃ id	string	The Id of the group. Formatted as a GUID.
┃ name	string	The name of the group.
┗ courses	array	A list of courses that are assigned to the group.
┃ id	string	The Id of the course. Formatted as a GUID.
┗ name	string	The name of the course.
page	integer	The current page of results (Starts at 1).
entitiesReturned	integer	The number of filters in the entities array.
totalEntities	integer	The total entities across all pages.
links	array	A list of links relevant to the current request. No links are currently returned with this request.

Example

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Example Group",
      "courses": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Safety Course A"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Manager Course B"
        }
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 1,
  "links": []
}