GET /v1/signature/envelopes/{id}/timeline

GET

/v1/signature/envelopes/{id}/timeline

curl --request GET \
  --url https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/timeline \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  signature:read
• session

Parameters

Path Parameters

id

required

string format: uuid

Envelope identifier.

Responses

200

Readable chronology, oldest first.

Media type application/json

Array<object>

One readable entry in an envelope’s chronology.

object

content_hash

required

SHA-256 of the canonical content (hex) — kept for chain verification.

string

event_data

required

Structured payload (recipient counts, masked metadata, …).

event_type

required

Event kind (created, sent, viewed, reminder_sent, reactivated, …) — the client maps it to a localized label.

string

occurred_at

required

When the event occurred (RFC3339).

string

seq_index

required

0-based position in the chain.

integer format: int64

signer_email

The signer’s email, resolved from signer_id for display.

string | null

signer_id

The signer the event concerns, if any.

string | null format: uuid

Example ^generated

[
  {
    "content_hash": "example",
    "event_data": "example",
    "event_type": "example",
    "occurred_at": "example",
    "seq_index": 1,
    "signer_email": "example",
    "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing signature:read scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}