Get Template
Retrieve details of a specific template using the Docstron API. This endpoint allows you to fetch template information, content, and styling.
Endpoint
Section titled “Endpoint”GET https://api.docstron.com/v1/templates/{template_id}
Authentication
Section titled “Authentication”This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Parameters
Section titled “Parameters”Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
template_id | string | Yes | The unique identifier of the template (e.g., template-c2465c0b-fc54-4672-b9ac-7446886cd6de ) |
Request Examples
Section titled “Request Examples”curl --location 'https://api.docstron.com/v1/templates/template-c2465c0b-fc54-4672-b9ac-7446886cd6de' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --data ''
Response
Section titled “Response”200 - Success Response
{ "success": true, "message": "Request successful", "data": { "template_id": "template-c2465c0b-fc54-4672-b9ac-7446886cd6de", "application_id": "app-7b4d78fb-820c-4ca9-84cc-46953f210301", "name": "Template 1", "is_active": true, "created_at": "2025-10-12T17:06:33", "updated_at": "2025-10-12T17:06:33", "content": "<h1>Hello World!</h1>", "extra_css": "@page { margin: 3cm; @bottom-left { color: #1ee494; content: '♥ Thank you!'; } }" }}
Response Fields
Section titled “Response Fields”Field | Type | Description |
---|---|---|
success | boolean | Indicates if the request was successful |
message | string | A message describing the response |
data | object | The created template object |
data.template_id | string | Unique identifier of the created template |
data.application_id | string | The application ID associated with this template |
data.name | string | Name of the template |
data.is_active | boolean | Whether the template is active (true ) or inactive (false ) |
data.created_at | string | Timestamp when the template was created (ISO 8601 format) |
data.updated_at | string | Timestamp when the template was last updated (ISO 8601 format) |
data.content | string | HTML content of the template |
data.extra_css | string | Additional CSS rules for PDF styling |
Error Responses
Section titled “Error Responses”404 - Template Not Found
Returned when the provided template_id
does not exist or is invalid.
{ "success": false, "message": "Template not found.", "data": []}
Common causes:
- Invalid or mistyped
template_id
- Template has been deleted
- The template belongs to a different application
Solution: Verify the template_id
is correct. You can list all templates by creating them through the Create Template endpoint and storing their IDs.
500 - Internal Server Error
Returned when an unexpected server error occurs while retrieving the template.
{ "success": false, "message": "Failed to get the template.", "data": []}
Common causes:
- Temporary server issue
- Database connectivity problem
- Service maintenance
Solution: Wait a few moments and retry the request. If the problem persists, contact support@docstron.com.
Need Help?
Section titled “Need Help?”If you have questions about applications or need assistance:
- 📧 Email: support@docstron.com
- 💬 Live Chat: Available in your dashboard
- 📚 Documentation: You’re reading it!