GET group/…/members

GET Retrieves all members of a specific group, or searches through the list.

Resource URL

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

The group ID is the unique identifier of the group.

Parameters

Field Type Description
query
optional
String

The text to search for in the user names. The search is case-insensitive.

If a query is present, the list of user records in the response is sorted by relevance. In the absence of a query, the response is sorted by signup date.

Example values: Jane

resultStart
optional
Integer

The index number (zero-based) of the first 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 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) group members are returned.

Response

A 2.0 Group object, populated with its group members. Users who are invited to the group, but have not yet accepted or declined the invitation are also included in the response.

Example request

GET https://www.drillster.com/api/2/group/nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI/members

Response

{
  "id" : "nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI",
  "name" : "European geography",
  "description" : "Learn the countries and capitals of Europe",
  "members" : [ {
    "id" : "BOR_04dNRNa_hGCL09UtyA",
    "name" : "Adam Smith",
    "joined" : "2013-05-17T06:52:23Z",
    "emailAddress" : "adam.smith@example.com"
  }, {
    "id" : "tOsrtOKrSiigIMQQi7Rbmw",
    "name" : "George Baker",
    "joined" : "2014-03-18T06:46:00Z",
    "emailAddress" : "george@example.com"
  }, {
    "id" : "Z1Sql1p3T0e_uN-jmYQ0XQ",
    "name" : "Oscar Wilde",
    "joined" : "2015-06-11T08:33:19Z",
    "emailAddress" : "oscar.wilde@example.com",
    "status" : "invited"
  }, {
    "emailAddress" : "gene@hackman.com",
    "status" : "invited"
  } ],
  "counts" : {
    "members" : 4,
    "drillables" : 0,
    "tests" : 0
  }
}

Error responses

The following error situations are possible:

ID Description
group_not_found Could not retrieve group details.
drill_code_missing No drill specified.
no_group_access You are not allowed to access the details of this group.