AutomatedDocs API - Templates

Get Templates

GET https://automateddocs.com/api/template

This endpoint retrieves a list of templates available in the AutomatedDocs system.

Authentication

This request requires an authentication token to be included in the header.

  • Header: Authorization: Bearer {token}

Replace {token} with your actual bearer token.

Response Format

The response is in JSON format with the following structure:

{
  "success": true,
  "templates": {
    "current_page": 1,
    "data": [
      {
        "uuid": "string",
        "name": "string",
        "fields": "string (JSON)",
        "original_filename": "string",
        "google_doc_id": "string or null",
        "description": "string",
        "output_filename": "string or null",
        "output_filetype": "string or null",
        "editable": "boolean or null",
        "password": "string or null",
        "expiration": "integer"
      }
      // additional template objects
    ],
    "first_page_url": "string",
    "from": "integer",
    "last_page": "integer",
    "last_page_url": "string",
    "links": [
      {
        "url": "string or null",
        "label": "string",
        "active": "boolean"
      }
      // additional link objects
    ],
    "next_page_url": "string or null",
    "path": "string",
    "per_page": "integer",
    "prev_page_url": "string or null",
    "to": "integer",
    "total": "integer"
  }
}

Get a Template

GET https://automateddocs.com/api/template/{uuid}

Retrieves detailed information about a specific template identified by its UUID. The UUID for a template can be found on the template settings page or by making a call to the list of templates endpoint.

Parameters

  • uuid (required): The unique identifier for the template. It should be substituted in the URL.

Authentication

This request requires an authentication token to be included in the header.

  • Header: Authorization: Bearer {token}

Replace {token} with your actual bearer token.

Response Format

The response is in JSON format with the following structure:

{
  "success": true,
  "template": {
    "uuid": "string",
    "name": "string",
    "fields": "string (JSON)",
    "original_filename": "string",
    "google_doc_id": "string or null",
    "description": "string",
    "output_filename": "string or null",
    "output_filetype": "string",
    "editable": "integer",
    "password": "string or null",
    "expiration": "integer"
  }
}

Delete a Template

DELETE https://automateddocs.com/api/template/{uuid}

Deletes a specific template identified by its UUID. The UUID for a template can be found on the template settings page or by making a call to the list of templates endpoint.

Parameters

  • uuid (required): The unique identifier for the template. It should be substituted in the URL.

Authentication

This request requires an authentication token to be included in the header.

  • Header: Authorization: Bearer {token}

Replace {token} with your actual bearer token.

Response Format

The response will be in JSON format, typically indicating success:

{
  "success": true,
  "message": "Template deleted successfully."
}