Skip to Content
API Reference
Download TemplateGET

Download Template

Download your original template file in .docx used to generate documents.

Endpoint

You can retrieve a template by sending a GET request to the following endpoint:

GET https://docubloom.com/api/template/download?templateKey=<key>

Headers

All requests must include your API key in the Authorization header. If you don’t have an API key yet, you can create one in your organization settings.

Authorization: Bearer YOUR_API_KEY

Request Parameters

Definition of fields

FieldTypeRequiredDescription
templateKey (Query Parameter)stringKey of the template to download

Example Request

POST https://docubloom.com/api/template/download?templateKey=my-template-key

Response

If the request is successful, you will receive a 200 OK status code along with the template content in the response body. The Content-Type header will be:

application/vnd.openxmlformats-officedocument.wordprocessingml.document

Status Codes

The API will return different HTTP status codes based on the outcome of your request.

StatusDescription
200Template downloaded successfully
400Invalid request parameters
401Unauthorized – missing or invalid API key
404Template not found
500Internal server error
Last updated on