Skip to main content
GET
/
v1
/
envelopes
/
{envelope_id}
/
events
// GET https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_0iuY6H...",
    "previous": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_87unYn..."
  },
  "data": [
    {
      "id": "evt_45b62ui33fCihBWpW2kWDa",
      "type": "envelope.completed",
      "timestamp": "2024-12-31T23:59:00.000Z",
      "data": {
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_type": "envelope"
      }
    },
    {
      "id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
      "type": "recipient.completed",
      "timestamp": "2024-12-31T23:58:59.000Z",
      "data": {
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client"
      }
    },
    {...},
    {...}
  ]
}
Returns a list of the events of an envelope. The events are sorted by timestamp, with the most recent appearing first. Envelope events include recipient and deliverable events.

​
Path Parameters

​
envelope_id
uuid
required
The unique identifier of an envelope.

​
Query Parameters

​
type
enum
Filter the list by event type, for example envelope.completed or recipient.sent.For the list of event types, see:
​
limit
integer
The maximum number of objects to return in the response, up to 20. The default is 20.
For certain use cases we can increase the limit. Please contact us at support@signatureapi.com.

​
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/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_0iuY6H...",
    "previous": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_87unYn..."
  },
  "data": [
    {
      "id": "evt_45b62ui33fCihBWpW2kWDa",
      "type": "envelope.completed",
      "timestamp": "2024-12-31T23:59:00.000Z",
      "data": {
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_type": "envelope"
      }
    },
    {
      "id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
      "type": "recipient.completed",
      "timestamp": "2024-12-31T23:58:59.000Z",
      "data": {
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client"
      }
    },
    {...},
    {...}
  ]
}