Retrieve Membership Collection

CUSTOM-ENDPOINT

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

CUSTOM-REQUEST

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

Parameters

NameTypeDescription
networkEIDEIDNetwork EID

Filters

NameTypeDescription
groupEIDFilters all memberships for a specific group in a certain network
qstringFilters all memberships with the names of the appropriate users matching the specified terms
rolestringFilters all memberships matching the specified role (or comma separated roles). Role can be the key of a built-in role or the EID of a user-defined one
excluded_rolestringSame as above, but the memberships not matching any of the roles are returned

Response

StatusData
200Returns a collection of Membership resource
403Unauthorized: returns an Error object