Manage document templates programmatically with the Templates API. Create, update, and organize your templates for automated document generation.
https://api.docaflex.com/v1/templates
All API requests require authentication. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Retrieve a list of all templates in your workspace.
Parameter | Type | Description |
---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Items per page (default: 20, max: 100) |
category | string | Filter by template category |
{
"templates": [
{
"id": "tpl_123456",
"name": "Invoice Template",
"description": "Standard invoice template",
"category": "finance",
"fields": [
{
"name": "customer_name",
"type": "string",
"required": true
},
{
"name": "amount",
"type": "number",
"required": true
}
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 45,
"pages": 3
}
}
Create a new document template.
{
"name": "Contract Template",
"description": "Standard service contract",
"category": "legal",
"content": "Contract content with {{placeholders}}",
"fields": [
{
"name": "client_name",
"type": "string",
"required": true,
"description": "Client company name"
},
{
"name": "start_date",
"type": "date",
"required": true,
"description": "Contract start date"
}
],
"settings": {
"output_format": "pdf",
"auto_generate": true
}
}
{
"id": "tpl_789012",
"name": "Contract Template",
"status": "active",
"created_at": "2024-01-15T11:00:00Z"
}
Update an existing template.
id
(string) - Template IDSame structure as POST request. Only include fields you want to update.
Delete a template. This action cannot be undone.
{
"message": "Template deleted successfully"
}
Supported field types for template placeholders:
string
- Text contentnumber
- Numeric valuesdate
- Date valuesboolean
- True/false valuesemail
- Email addressesurl
- Web URLscurrency
- Monetary valuesarray
- List of values400
- Bad Request: Invalid request data401
- Unauthorized: Invalid or missing API key403
- Forbidden: Insufficient permissions404
- Not Found: Template not found429
- Too Many Requests: Rate limit exceeded