Retrieve Users Collection

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

Authorization

Permissions:get_profiles

Request

URI:/networks/{networkEID}/users/
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
addable_to EID Since 1.1.2 Returns users that can be added to the specified group EID
alert EID Returns only authors related to a coalesced alert
commented EID Returns only commenters that commented on the specified (parent) message
conversation EID Returns only users participating in the specified conversation
eid EIDs Returns only specific users, see Multi-GET
exclude_group string Since 1.1.6 In combination with group this will return group members excluding the members of the specified group
exclude_role string Returns only users not matching one of the roles
external boolean If true, only returns external users
group EID Returns only users that are member of a specific group
modified_since datetime Since 1.0.13 Filters users who have changed their profile since the specified date and time
q string Returns only users whose full names or job titles match the specified terms
role string Returns only users by their role in a group or the network. Multiple roles can be specified, separated by commas
scope string Since 1.1 Limits the returned users to one of the following scopes: my_groups, relevant_users or network

Response

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