GET group/subscriptions
Retrieves an overview of group subscriptions.
There are two use cases:
- Retrieve the list of groups that the calling user is a member of
- Retrieve the list of groups that a specific user is a member of
Resource URL
https://www.drillster.com/api/2.1.1/group/subscriptions
Parameters
Field | Type | Description |
---|---|---|
query optional |
String | The text to search for in the subscriptions. The search is case-insensitive. |
groupMemberId optional |
String | The account ID of a member of any of the groups managed by the calling user. Only groups that are managed by the calling user for which the specified user is a member will be returned. If the value is omitted, the caller's own group subscriptions are returned. |
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 subscriptions to include in the result. If not specified, the results for all (remaining) subscriptions are returned. |
Response
A 2.1.1 Groups object, with details about the groups and the organizations owning those groups.
Last updated on