E-Signatures

Get session details

Returns comprehensive signing session information including signer statuses, e-sign fields with positions, document hashes, and completion timestamps.

get/esign/sessions/{sessionId}

Path parameters

sessionIdstring required

The signing session ID.

Response

Session details

idstring

documentNamestring

status'pending' | 'in_progress' | 'completed' | 'declined' | 'cancelled'

signingOrder'sequential' | 'parallel'

deliveryMethod'email' | 'link'

currentSignerIndexinteger

originalPdfUrlstring uri

signedPdfUrlstring uri nullable

originalDocumentHashstring

signedDocumentHashstring nullable

reminderEnabledboolean

reminderDaysinteger

webhookParamsobject nullable

Custom parameters passed in the original document creation request (webhookParams), returned verbatim. The trigger record identifier is folded in automatically — recId (Airtable, SmartSuite, Notion), taskId (ClickUp) or rowNumber (Google Sheets; positional at trigger time) — useful for correlating sessions with records in your data source. Caller-supplied keys are never overwritten. null when no identifier or parameters were provided.

expiresAtstring date-time

completedAtstring date-time nullable

createdAtstring date-time

Example response

{
  "webhookParams": {
    "recId": "recAbC123XyZ",
    "orderId": "ORD-123"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.