Skip to main content
GET
/
esign
/
sessions
/
{sessionId}
Get session details
curl --request GET \
  --url https://api.docsautomator.co/esign/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "documentName": "<string>",
  "currentSignerIndex": 123,
  "originalPdfUrl": "<string>",
  "signedPdfUrl": "<string>",
  "originalDocumentHash": "<string>",
  "signedDocumentHash": "<string>",
  "esignFields": [
    {
      "fieldId": "<string>",
      "label": "<string>",
      "required": true,
      "value": "<string>",
      "signedAt": "2023-11-07T05:31:56Z",
      "signerIndex": 123
    }
  ],
  "signers": [
    {
      "index": 123,
      "email": "<string>",
      "name": "<string>",
      "role": "<string>",
      "invitedAt": "2023-11-07T05:31:56Z",
      "openedAt": "2023-11-07T05:31:56Z",
      "signedAt": "2023-11-07T05:31:56Z",
      "consentGivenAt": "2023-11-07T05:31:56Z",
      "signingDurationSeconds": 123
    }
  ],
  "reminderEnabled": true,
  "reminderDays": 123,
  "webhookParams": {
    "recId": "recAbC123XyZ",
    "orderId": "ORD-123"
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

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,
declined,
cancelled
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

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:
{
"recId": "recAbC123XyZ",
"orderId": "ORD-123"
}
expiresAt
string<date-time>
completedAt
string<date-time> | null
createdAt
string<date-time>
Last modified on June 12, 2026