{
  "opencollection": "1.0.0",
  "info": {
    "name": "DocuSeal Submissions Templates API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docuseal.com/templates",
            "params": [
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Filter templates based on the name partial match."
              },
              {
                "name": "slug",
                "value": "opaKWh8WWTAcVG",
                "type": "query",
                "description": "Filter templates by unique slug."
              },
              {
                "name": "external_id",
                "value": "",
                "type": "query",
                "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID."
              },
              {
                "name": "folder",
                "value": "",
                "type": "query",
                "description": "Filter templates by folder name."
              },
              {
                "name": "archived",
                "value": "",
                "type": "query",
                "description": "Get only archived templates instead of active ones."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of templates to return. Default value is 10. Maximum value is 100."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the ability to retrieve a list of available document templates."
        },
        {
          "info": {
            "name": "Get a template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docuseal.com/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "1000001",
                "type": "path",
                "description": "The unique identifier of the document template."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the functionality to retrieve information about a document template."
        },
        {
          "info": {
            "name": "Update a template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docuseal.com/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "1000001",
                "type": "path",
                "description": "The unique identifier of the document template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the functionality to move a document template to a different folder and update the name of the template."
        },
        {
          "info": {
            "name": "Archive a template",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docuseal.com/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "1000001",
                "type": "path",
                "description": "The unique identifier of the document template."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint allows you to archive a document template."
        },
        {
          "info": {
            "name": "Update template documents",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docuseal.com/templates/:id/documents",
            "params": [
              {
                "name": "id",
                "value": "1000001",
                "type": "path",
                "description": "The unique identifier of the document template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content."
        },
        {
          "info": {
            "name": "Clone a template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docuseal.com/templates/:id/clone",
            "params": [
              {
                "name": "id",
                "value": "1000001",
                "type": "path",
                "description": "The unique identifier of the document template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint allows you to clone an existing template into a new template."
        },
        {
          "info": {
            "name": "Create a template from HTML",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docuseal.com/templates/html",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.<br><b>Related Guides</b><br><a href=\"https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api\" class=\"link\">Create PDF document fillable form with HTML</a>"
        },
        {
          "info": {
            "name": "Create a template from Word DOCX",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docuseal.com/templates/docx",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href=\"https://www.docuseal.com/examples/fieldtags.docx\" target=\"_blank\" class=\"link font-bold\" >https://www.docuseal.com/examples/fieldtags.docx</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<b"
        },
        {
          "info": {
            "name": "Create a template from PDF",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docuseal.com/templates/pdf",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint provides the functionality to create a fillable document template for a PDF file. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href=\"https://www.docuseal.com/examples/fieldtags.pdf\" target=\"_blank\" class=\"link font-bold\">https://www.docuseal.com/examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><"
        },
        {
          "info": {
            "name": "Merge templates",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docuseal.com/templates/merge",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The API endpoint allows you to merge multiple templates with documents and fields into a new combined template."
        }
      ]
    }
  ],
  "bundled": true
}