Events
List recipient events
Events
List recipient events
GET
/
v1
/
recipients
/
{recipient_id}
/
events
Returns a list of the events of a recipient. The events are sorted by timestamp, with the most recent appearing first.
Path Parameters
recipient_id
string
requiredThe unique identifier of a recipient.
Query Parameters
type
enum
Filter the list by event type, for example recipient.completed or recipient.sent.
For the list of event types, see Event Types.
limit
integer
The maximum number of objects to return in the response, up to 100. The default is 20.
Returns
Returns a 200 OK status code along with a paginated list of event objects if successful, or an error otherwise.
Was this page helpful?