// GET https://api.signatureapi.com/v1/events
// X-API-Key: key_test_...
{
"links": {
"next": "https://api.signatureapi.com/v1/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "envelope.completed",
"data": {
"object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "envelope"
},
"timestamp": "2024-12-31T23:59:00.000Z"
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.completed",
"data": {
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "recipient",
"recipient_type": "signer",
"recipient_key": "client"
},
"timestamp": "2024-12-31T23:58:59.000Z"
},
{...},
{...}
]
}
Lists all events in an account.
// GET https://api.signatureapi.com/v1/events
// X-API-Key: key_test_...
{
"links": {
"next": "https://api.signatureapi.com/v1/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "envelope.completed",
"data": {
"object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "envelope"
},
"timestamp": "2024-12-31T23:59:00.000Z"
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.completed",
"data": {
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "recipient",
"recipient_type": "signer",
"recipient_key": "client"
},
"timestamp": "2024-12-31T23:58:59.000Z"
},
{...},
{...}
]
}
envelope.completed
or recipient.hard_bounced
.For the list of event types, see:200 OK
status code along with a paginated list of event objects if successful, or an error otherwise.
// GET https://api.signatureapi.com/v1/events
// X-API-Key: key_test_...
{
"links": {
"next": "https://api.signatureapi.com/v1/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "envelope.completed",
"data": {
"object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "envelope"
},
"timestamp": "2024-12-31T23:59:00.000Z"
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.completed",
"data": {
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "recipient",
"recipient_type": "signer",
"recipient_key": "client"
},
"timestamp": "2024-12-31T23:58:59.000Z"
},
{...},
{...}
]
}