GET
/
v1
/
recipients
/
{recipient_id}
/
events
// GET https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events
// X-API-Key: key_test_...

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

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
required

The 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.

// GET https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events
// X-API-Key: key_test_...

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