Skip to main content
GET
Get session details

Authorizations

Authorization
string
header
required

API key from your workspace settings. Pass as Authorization: Bearer <key> or X-API-Key: <key>. Find it at app.docsautomator.co/settings/workspace/api.

Path Parameters

sessionId
string
required

The signing session ID.

Response

Session details

id
string
documentName
string
status
enum<string>
Available options:
pending,
in_progress,
completed,
expired,
declined,
cancelled
closeType
enum<string>

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

Available options:
signature,
acceptance
signingOrder
enum<string>
Available options:
sequential,
parallel
deliveryMethod
enum<string>
Available options:
email,
link
currentSignerIndex
integer
originalPdfUrl
string<uri>
signedPdfUrl
string<uri> | null
originalDocumentHash
string
signedDocumentHash
string | null
esignFields
object[]
signers
object[]
reminderEnabled
boolean
reminderDays
integer
webhookParams
object | null

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.

Example:
expiresAt
string<date-time>
completedAt
string<date-time> | null
createdAt
string<date-time>
Last modified on September 24, 2026