Retrieve Groups Collection

GET https://api.speakap.io/networks/:eid/groups/

Authorization

Permissions:list_groups

Request

URI:/networks/{networkEID}/groups/
Method:GET
Accept:application/vnd.speakap.api-v1.8.2+json+hal
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID

Filters

Name Type Description
addressable_for string Since 1.1.1 Returns groups that can be valid recipients of news items
ancestor EID Since 1.1.5 Returns subgroups (all descendants) of the specified ancestor
admin EID Returns only groups the specified user is administrator for
include_hidden boolean Since 1.1 Include hidden groups in the result
include_secret boolean Include secret groups in the result
invitee EID Returns only groups the specified user has pending invitations for
label EID+ Since 1.1.7 Returns the groups under one or more labels
modified_since datetime Since 1.0.13 Returns only groups that have been modified since the specified date and time. Addition or removal of a member also counts as a modification.
parent EID Since 1.1 Returns subgroups (direct children) of the specified parent
permission string Since 1.4.1 Returns the groups where a certain permission is granted
q string Return only groups whose names match the specified terms
role string Since 1.0.26 Returns groups in which the user, listed below, has a specific role
scope string Since 1.1 Limits the returned groups to one of the following scopes: my_groups, relevant_groups or network
type string+ Since 1.1 Returns the group whose type matches the specified type. Type basic can be used to exclude all enterprise type groups.
user EID Returns only groups the specified user is member of

Response

200
Returns a collection of Group resources
403
Unauthorized: returns an Error object