> ## 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 automation

> Retrieves a single automation by ID with full configuration details.



## OpenAPI

````yaml /openapi.json get /automation
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:
  /automation:
    get:
      tags:
        - Automations
      summary: Get automation
      description: Retrieves a single automation by ID with full configuration details.
      operationId: getAutomation
      parameters:
        - name: automationId
          in: query
          required: false
          schema:
            type: string
          description: The automation ID. Either `automationId` or `docId` is required.
        - name: docId
          in: query
          required: false
          schema:
            type: string
          description: Alternative to `automationId`.
      responses:
        '200':
          description: Automation details
          content:
            application/json:
              schema:
                type: object
                properties:
                  automation:
                    $ref: '#/components/schemas/Automation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Automation:
      type: object
      properties:
        _id:
          type: string
          description: Automation ID.
        title:
          type: string
        dataSource:
          type: object
          properties:
            name:
              type: string
        dataSourceName:
          type: string
        docTemplateLink:
          type: string
          format: uri
          description: Google Doc template URL.
        newDocumentNameField:
          type: string
        isActive:
          type: boolean
        saveGoogleDoc:
          type: boolean
        locale:
          type: string
        formatNumbersWithLocale:
          type: boolean
        pdfExpiration:
          type: string
          nullable: true
        dateCreated:
          type: string
          format: date-time
        lastPreviewPdf:
          type: string
          format: uri
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message.
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Missing required parameter
    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).

````