GET
/
v1
/
events
// 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"
      },
      "timestamp": "2024-12-31T23:58:59.000Z"
    },
    {...},
    {...}
  ]
}

Returns a list of all events for all envelopes. The events are sorted by timestamp, with the most recent appearing first.

These events include envelope, recipient and deliverable events.

​
Query Parameters

type
enum

Filter the list by event type, for example envelope.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.

// 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"
      },
      "timestamp": "2024-12-31T23:58:59.000Z"
    },
    {...},
    {...}
  ]
}

Was this page helpful?

Event typesList envelope events