"GET /openapi/v1/groups" method

Getting the list of groups available for this company.

Request

Header:

• Authorization – the company's API token.

Response

• total – a number – The number of group's available in the company.
• result – an array – An array of objects with data on the available groups.
  • id – a string – The group's identifier.
  • name – a string – The group's name.
  • isStarted – a boolean – Indicates whether training has started in the group.

Example of a response: {     total: 1,     result: [{         id: '627d5c63f0672a10fbac23bb',         name: 'Low risk',         isStarted: true     }] }

Possible errors:

• 401 - common-unauthorized - There was an authentication error.
• 404 – groups-not-found – No group associated with this token was found for the company.
• 429 – too-many-requests – There were too many requests.
• 500 – internal-server-error – There was an internal server error.

To the top