Retrieve Groups Collection

CUSTOM-ENDPOINT

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

CUSTOM-AUTHORIZATION

Permissions: list_groups

CUSTOM-REQUEST

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

Parameters

NameTypeDescription
networkEIDEIDNetwork EID

Filters

NameTypeDescription
addressable_forstringSince 1.1.1 Returns groups that can be valid recipients of news items
ancestorEIDSince 1.1.5 Returns subgroups (all descendants) of the specified ancestor
adminEIDReturns only groups the specified user is administrator for
include_hiddenbooleanSince 1.1 Include hidden groups in the result
include_secretbooleanInclude secret groups in the result
inviteeEIDReturns only groups the specified user has pending invitations for
labelEID+Since 1.1.7 Returns the groups under one or more labels
modified_sincedatetimeSince 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.
parentEIDSince 1.1 Returns subgroups (direct children) of the specified parent
permissionstringSince 1.4.1 Returns the groups where a certain permission is granted
qstringReturn only groups whose names match the specified terms
rolestringSince 1.0.26 Returns groups in which the user, listed below, has a specific role
scopestringSince 1.1 Limits the returned groups to one of the following scopes: my_groupsrelevant_groups or network
typestring+Since 1.1 Returns the group whose type matches the specified type. Type basic can be used to exclude all enterprise type groups.
userEIDReturns only groups the specified user is member of

Response

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