Skip to main content
GET
/
job
/
{jobId}
Get job status
curl --request GET \
  --url https://api.docsautomator.co/job/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "<string>",
  "progress": 50,
  "createdAt": "2023-11-07T05:31:56Z",
  "processedOn": "2023-11-07T05:31:56Z",
  "finishedOn": "2023-11-07T05:31:56Z",
  "result": {
    "message": "success",
    "pdfUrl": "<string>",
    "documentName": "<string>",
    "googleDocUrl": "<string>",
    "savePdfGoogleDriveUrl": "<string>",
    "savePdfGoogleDriveFileId": "<string>",
    "signingSessionId": "<string>",
    "signingLinks": [
      {
        "signerIndex": 123,
        "email": "<string>",
        "name": "<string>",
        "signingUrl": "<string>",
        "status": "<string>"
      }
    ]
  },
  "error": "<string>",
  "attempts": 123
}

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

jobId
string
required

The job ID returned from async document creation.

Response

Job status retrieved

jobId
string
status
enum<string>

Current job status.

Available options:
waiting,
active,
completed,
failed
progress
integer

Progress percentage (10 → 20 → 30 → 40 → 100).

Required range: 0 <= x <= 100
createdAt
string<date-time>
processedOn
string<date-time>

When processing started.

finishedOn
string<date-time>

When processing finished.

result
object

The document creation result (only present when status is completed).

error
string

Error message (only present when status is failed).

attempts
integer

Number of processing attempts.

Last modified on May 26, 2026