GET group/…/staff

Retrieves the staff permissions for a group.

Resource URL

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

The group ID is the unique identifier of the group.

Parameters

Field	Type	Description
`group_id` required	String	The ID of the group.
`query` optional	String	The text to search for in the staff user names. The search is case-insensitive. Example values: `Jane`
`resultStart` optional	Integer	The index number (zero-based) of the first staff user to include in the result. Use this parameter, in combination with `resultSize`, to apply pagination of the result; it will limit the number of staff users included in the result. Defaults to 0.
`resultSize` optional	Integer	The maximum number of users to include in the result. If not specified, the results for all (remaining) staff users are returned.

Response

A 2.1.1 GroupStaff object detailing the individual staff permissions for the group.

Example request

GET https://www.drillster.com/api/2.1.1/group/pX3rn8LnXn5QM3mzwmSXDnDYeDpsnIqsHoXEKN2N3_B/staff

Response

{
  "group": {
    "id": "pX3rn8LnXn5QM3mzwmSXDnDYeDpsnIqsHoXEKN2N3_B"
  },
  "count": 1,
  "groupStaffUsers": [ {
    "group": {
      "id": "pX3rn8LnXn5QM3mzwmSXDnDYeDpsnIqsHoXEKN2N3_B"
    },
    "user": {
      "type": "USER",
      "id": "m3XfGV1LQhu729lfVYa_sQ",
      "name": "Jane Doe",
      "avatar": {
        "type": "image/png",
        "url": "https://www.drillster.com/bin/avatar/330b901c200be68b852885e3a7eb31f7e938f29d"
      },
      "locale": "nl"
    },
    "permission": "MANAGE"
  } ]
}

Error responses

The following error situations are possible:

ID	Description
`not_permitted`	User is not entitled to view details for requested group.
`unknown_group`	Given group is unknown.