GET group/…

Retrieves the details for a specific group. The calling user must have at least VIEW permission on the group.

Resource URL

https://www.drillster.com/api/2.1/group/{group_id}

Parameters

Field	Type	Description
`groupId` required	String	The ID of the group to be retrieved. Example value: `Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc`

Response

A 2.1 Group object containing the group details.

Example request

GET https://www.drillster.com/api/2.1/group/Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc

Response

{
  "id": "mRdhqCfGQMOAlnN3SIlwvQ-2",
  "name": "Test group",
  "description": "This is a test",
  "counts": {
    "members": 1,
    "drillables": 1,
    "tests": 3
  },
  "icon": {
    "type": "image/png",
    "url": "https://www.drillster.com/img/icon-groups.png"
  },
  "created": "2015-07-21T16:48:08Z",
  "lastEdited": "2015-07-21T16:48:08Z",
  "organization": {
    "id": "TIabcdxT3U0mMhwidmxVDQ",
    "type": "ORGANIZATION",
    "mayCreateGroupMemberAccounts": false
  }
}

Error responses

The following error situations are possible:

ID	Response code	Description
`missing_group_id`	400 (Bad request)	No group ID given
`no_permission`	403 (Forbidden)	No access to group
`not_found`	404 (Not found)	Requested group not found
`invalid_group_id`	400 (Bad request)	Given group ID is not valid