Retrieve User

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

Required Application Permission

N/A

Request

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

Parameters

Name Type Description
networkEID EID Network EID

Filters

Name Type Description
group EID Filters all users that are member of a specific group
type string Resource type facets (see below)

Resource type facets

Type Resource
user Users
group Groups
message:file Messages of type file
message:file:image Messages of type file and file.type image
message:file:document Messages of type file and file.type document
message:update Messages of type update
message:comment Messages of type comment
message:private Messages of type private
message:news Messages of type news
conversation>message Conversations (while searching in private message children)

Examples

Search users in a certain group with “john” in their name or job title:

GET https://api.speakap.io/networks/:eid/search/?type=user&q=john&group=1234567890ABCDEF

Search documents that contain “planning” in their filename:

GET https://api.speakap.io/networks/:eid/search/?type=message:file:document&q=planning

Search all message types for the text “Hello”:

GET https://api.speakap.io/networks/:eid/search/?type=message:update,message:comment&q=Hello

Search all conversations with messages containing the text “Thanks”:

GET https://api.speakap.io/networks/:eid/search/?type=conversation>message&q=Thanks

Response

200
Returns a HAL response with embedded resources depending on the type filter
403
Unauthorized: returns an Error object