Retrieve Users Collection

CUSTOM-ENDPOINT

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

CUSTOM-AUTHORIZATION

Permissions: get_profiles

CUSTOM-REQUEST

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

Parameters

NameTypeDescription
networkEIDEIDNetwork EID

Filters

NameTypeDescription
addable_toEIDSince 1.1.2 Returns users that can be added to the specified group EID
alertEIDReturns only authors related to a coalesced alert
commentedEIDReturns only commenters that commented on the specified (parent) message
conversationEIDReturns only users participating in the specified conversation
eidEIDsReturns only specific users, see Multi-GET
exclude_groupstringSince 1.1.6 In combination with group this will return group members excluding the members of the specified group
exclude_rolestringReturns only users not matching one of the roles
externalbooleanIf true, only returns external users
groupEIDReturns only users that are member of a specific group
modified_sincedatetimeSince 1.0.13 Filters users who have changed their profile since the specified date and time
qstringReturns only users whose full names or job titles match the specified terms
rolestringReturns only users by their role in a group or the network. Multiple roles can be specified, separated by commas
scopestringSince 1.1 Limits the returned users to one of the following scopes: my_groupsrelevant_users or network

Response

StatusData
200Returns a User resource
403Unauthorized: returns an Error object