GET organization/…/groups
Retrieves all groups associated with an organization.
Resource URL
https://www.drillster.com/api/2.1/organization/{organization}/groups
Parameters
Field | Type | Description |
---|---|---|
organization required |
String | The unique ID of the organization. As a reference to the own organization, the value self may also be used.Example value: nPjYUn0upc8dIm7yzTIBgQ |
query optional |
String | An optional query to filter by group name or description. If no query is given, all groups are returned. |
resultStart optional |
Integer | The index number (zero-based) of the first group to include in the result. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of groups included in the result. Defaults to 0 . |
resultSize optional |
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 Groups object, containing the total number of groups that were found (total
),
regardless of the optionally specified resultStart
and resultSize
, and a list of
2.1 Group objects (groups
).
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 |