GET group/…/members

Returns the list of group members.

Resource URL

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

Parameters

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

Example value: Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc
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 value: Jane
resultFrom
optional
String The ID of the element of the preceding page. The contents of this field depend on the context, and must always be copied from a 2.1.1 Pagination object, or otherwise omitted. The client must not determine the value themselves.
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.1.1 GroupMembers object containing the group details and a list of group members.

Example request

GET https://www.drillster.com/api/2.1.1/group/Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc/members

Response

{
  "members": [ {
    "member": {
      "type": "USER",
      "id": "dh4wGp-6SY2QHWVDE90B0w",
      "name": "Tom Drillster",
      "avatar": {
        "url": "https://www.drillster.com/bin/avatar/null/US"
      },
      "emailAddress": "tom@drillster.com",
      "realName": "Tom Drillster"
    },
    "joined": "2016-08-26T07:23:22Z"
  }, {
    "member": {
      "type": "USER",
      "id": "dh4wGp-6SY2QHWVDE90B0w",
      "name": "Tom Drillster",
      "avatar": {
        "url": "https://www.drillster.com/bin/avatar/null/US"
      },
      "emailAddress": "tom@drillster.com",
      "realName": "Tom Drillster"
    },
    "joined": "2016-02-23T15:36:57Z"
  } ],
  "counts": {
    "members": 4,
    "invitees": 1
  },
  "pagination": {
    "total": 5,
    "lastOnPage": "2016-02-23T15:36:57.814Z"
  }
}

 

Last updated on