GET organization/…/groups
Retrieves all groups associated with an organization.
Resource URL
https://www.drillster.com/api/2.1.1/organization/{organization_id}/groups
Parameters
| Field | Type | Description |
|---|---|---|
organization_idrequired |
String | The unique ID of the organization. As a reference to the own organization, the value self may also be used.Example value: nPjYUn0upc8dIm7yzTIBgQ |
queryoptional |
String | An optional query to filter by group name or description. If no query is given, all groups are returned. |
resultFromoptional |
String | The ID of the last element from the previous page as quoted in the 2.1.1 Pagination object. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of drillables included in the result. If it is not specified, the first page will be displayed. |
resultSizeoptional |
Integer | The maximum number of groups to include in the result. If not specified, the results for all (remaining) groups are returned. |
Response
A 2.1.1 Groups object, containing the pagination details, and a list of 2.1.1 Group objects.
Error responses
The following error situations are possible:
| ID | Response code | Description |
|---|---|---|
missing_organization |
400 (Bad request) | No organization ID given |
not_permitted |
403 (Forbidden) | Only own organization is accessible |
not_linked_to_organization |
401 (Unauthorized) | Not linked to an organization |
not_found |
404 (Not found) | Organization not found |