Skip to main content

GET /templates/html/:id

Once you have obtained a template then use the PDF from HTML API with the required templateId & templateData parameters defined. Use the dashboard to manage your HTML to PDF Templates.

Query parameters

No query parameters accepted.

Responses

ParameterTypeDescription
idintegerTemplate ID.
typestringTemplate type.
titlestringTemplate title.
descriptionstringTemplate description.
test_jsonstringTemplate test JSON.
updated_atstringTemplate updated at.
bodystringTemplate content.
remainingCreditsintegerNumber of credits remaining in the account
creditsintegerNumber of credits consumed by the request

Example Payload

To see the request size limits, please refer to the Request Size Limits.

Example Response

To see the main response codes, please refer to the Response Codes page.
{
  "templates": [
    {
      "id": 1,
      "type": "system",
      "title": "General Invoice Template",
      "description": "sample invoice template showcasing use of Mustache templates syntax for generating invoices"
    },
    {
      "id": 15,
      "type": "user",
      "title": "User Template 1",
      "description": ""
    }
  ],
  "remainingCredits": 99204004,
  "credits": 2
}
Inconsistent URL Encoding in cURL Output: When using cURL to make API requests, the output JSON may show URL characters encoded as Unicode escape sequences. For example, the ampersand character (&) may appear as \u0026 in the cURL output. This is normal JSON encoding behavior and does not affect the validity of the URL. The URL will function correctly when used, as JSON parsers automatically decode these escape sequences. If you’re parsing the response programmatically, your JSON parser will handle this conversion automatically.

Code Samples

curl --location --request GET 'https://api.pdf.co/v1/templates/html' \
--header 'Content-Type: application/json' \
--header 'x-api-key: '