DOdocsautomator
E-Signatures

Get session details

Changed on

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

get/esign/sessions/{sessionId}

Request

Path parameters

sessionIdstring required

The signing session ID.

Response

Session details

idstring
documentNamestring
status'pending' | 'in_progress' | 'completed' | 'expired' | 'declined' | 'cancelled'
closeType'signature' | 'acceptance'

How the session closes. signature is the e-sign ceremony with template fields. acceptance is a review plus one click on Accept, without fields.

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

  • 890ec146a7f6Revision changes
    • warning

      added the new expired enum value to the response property for the response status

    • info

      added the optional property to the response with the status