Skip to content

Events

List recipient events

Returns all events for a specific recipient, sorted with the most recent first.

GET
/ v1 / recipients / {recipient_id} / events

Returns a list of events for a specific recipient. Events are sorted by timestamp, with the most recent appearing first.

Results include only recipient events, such as delivery, signing, and bounce events.

Path parameters

recipient_idstringrequired

The unique identifier of the recipient.

Query parameters

typeenum

Filter by event type. For example, recipient.completed or recipient.sent.

For the full list of event types available when listing recipient events, see Recipient Events.

limitinteger

The maximum number of objects to return. Minimum is 1, maximum is 20. Defaults to 20.

Returns

Returns a 200 OK status with a paginated list of event objects on success, or an error otherwise.