> ## Documentation Index
> Fetch the complete documentation index at: https://docsautomator.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get job status

> Check the status of an async document creation job. Poll this endpoint after receiving a `jobId` from `POST /createDocument` with `async: true`.

Progress values: 10% (queued) → 20% (fetching data) → 30% (processing template) → 40% (generating PDF) → 100% (complete).



## OpenAPI

````yaml /openapi.json get /job/{jobId}
openapi: 3.1.0
info:
  title: DocsAutomator API
  version: '2.0'
  description: >-
    REST API for programmatic document generation, automation management, and
    e-signature workflows.
  contact:
    name: DocsAutomator Support
    email: support@docsautomator.co
    url: https://docsautomator.co
servers:
  - url: https://api.docsautomator.co
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Documents
    description: Create documents and manage async jobs
  - name: Automations
    description: CRUD operations for automations
  - name: Templates
    description: Template placeholders and duplication
  - name: E-Signatures
    description: Manage signing sessions, links, and audit trails
  - name: Email
    description: Test email delivery
paths:
  /job/{jobId}:
    get:
      tags:
        - Documents
      summary: Get job status
      description: >-
        Check the status of an async document creation job. Poll this endpoint
        after receiving a `jobId` from `POST /createDocument` with `async:
        true`.


        Progress values: 10% (queued) → 20% (fetching data) → 30% (processing
        template) → 40% (generating PDF) → 100% (complete).
      operationId: getJobStatus
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
          description: The job ID returned from async document creation.
      responses:
        '200':
          description: Job status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatus'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    JobStatus:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
            - waiting
            - active
            - completed
            - failed
          description: Current job status.
        progress:
          type: integer
          minimum: 0
          maximum: 100
          description: Progress percentage (10 → 20 → 30 → 40 → 100).
        createdAt:
          type: string
          format: date-time
        processedOn:
          type: string
          format: date-time
          description: When processing started.
        finishedOn:
          type: string
          format: date-time
          description: When processing finished.
        result:
          $ref: '#/components/schemas/DocumentCreationResponse'
          description: >-
            The document creation result (only present when status is
            `completed`).
        error:
          type: string
          description: Error message (only present when status is `failed`).
        attempts:
          type: integer
          description: Number of processing attempts.
    DocumentCreationResponse:
      type: object
      properties:
        message:
          type: string
          example: success
        pdfUrl:
          type: string
          format: uri
          description: URL of the generated PDF.
        documentName:
          type: string
          description: Name of the generated document.
        googleDocUrl:
          type: string
          format: uri
          description: URL of the saved Google Doc (if `saveGoogleDoc` is enabled).
        savePdfGoogleDriveUrl:
          type: string
          format: uri
          description: Google Drive URL of the saved PDF (if Drive saving is configured).
        savePdfGoogleDriveFileId:
          type: string
          description: Google Drive file ID of the saved PDF.
        signingSessionId:
          type: string
          description: E-signature session ID (if e-signing is enabled on the automation).
        signingStatus:
          type: string
          enum:
            - created
            - queued
          description: Status of the signing session creation.
        signingLinks:
          type: array
          items:
            type: object
            properties:
              signerIndex:
                type: integer
              email:
                type: string
              name:
                type: string
              signingUrl:
                type: string
                format: uri
              status:
                type: string
          description: Signing links for each signer (if delivery method is `link`).
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message.
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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](https://app.docsautomator.co/settings/workspace/api).

````