GET group/subscriptions/…

Retrieves the details of a group that the calling user is subscribed to.

Resource URL

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

Parameters

Field Type Description
group_id
required
String The ID of the group.

Example value: 9Ez3bTy1AVX4N4MfTAWBgCQPTNxEFO6q6jaQXWx8GR8

Response

A 2.1.1 Group object, with details about the requested group and the organizations owning that group.

Example request

GET https://www.drillster.com/api/2.1.1/group/subscriptions/9Ez3bTy1AVX4N4MfTAWBgCQPTNxEFO6q6jaQXWx8GR8

Response

{
  "id": "9Ez3bTy1AVX4N4MfTAWBgCQPTNxEFO6q6jaQXWx8GR8",
  "name": "Induction training 2017",
  "description": "Contains various drills for induction training",
  "organization": {
    "type": "ORGANIZATION",
    "id": "mHCXPnI-QYqg0dsBC2e4SA",
    "name": "Acme Inc",
    "avatar": {
      "type": "image/png",
      "url": "https://www.drillster.com/bin/avatar/f58643c0b3a4456fe7d639ecff2905328ed6d5a6"
    }
  }
}

Error responses

The following error situations are possible:

ID Response code Description
invalid_group_id 400 (Bad request) The given group ID was is not valid.
not_found 404 (Not found) The requested group does not exist.
not_subscribed 403 (Forbidden) The calling user is not subscribed to the given group.