Retrieve Event Stream

get

https://staging.api.studyteamapp.com/rpi/events

Returns a list of events from the event stream matching the specified criteria in the order they were published. See Event Types for descriptions of the event types.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

eventTypes

array of strings, unique

required

An event type to be included in the response. This parameter can be included in the query multiple times to include multiple eventTypes
(e.g. eventTypes=v1.patient.statusChanged&eventTypes=v1.patient.referralAcknowledged)

trialIds

array of strings, unique

Include events for this StudyTeam trial ID. Can be used multiple times to include multiple trials. If omitted, will return events for all trials you are authorized to access.

trialIds

startingAfter

uuid

Return only events occurring after this event ID in the stream

limit

int64

1 to 100

Defaults to 50

A limit on the number of objects returned

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400400: Bad Request. The payload is invalid, which could be caused by bad encoding, invalid content, or validation errors. Will typically be accompanied by a message with details as to the cause of the failure.

401401: Unauthorized. The user failed to authenticate, which could be due to an expired or invalid access token or because the Authorization Header is incorrect or missing. It should be set to Authorization: Bearer ACCESS_TOKEN.

403403: Forbidden. The user is not authorized to perform the requested action.

500500: Internal Server Error.