pdfedge
API reference › Templates

One template: its overlay fields, the PDF's own form fields, and its defaults

GET/v1/templates/{id}

GET/v1/templates/{id}

One template: its overlay fields, the PDF's own form fields, and its defaults

PARAMETERS
idpath · stringREQUIRED
The template id
e.g. tpl_3h8kq2wzm4tnb7hdc3vr
In the full reference
REQUEST
curl "https://api.pdfedge.com/v1/templates/tpl_3h8kq2wzm4tnb7hdc3vr" \
  -H "X-API-Key: YOUR_KEY"
RESPONSE
200OK
{
  "id": "tpl_3h8kq2wzm4tnb7hdc3vr",
  "object": "template",
  "kind": "form",
  "name": "Membership application",
  "pages": 2,
  "bytes": 48211,
  "fields": [
    {
      "name": "signed_on",
      "page": 2,
      "x": 360,
      "y": 702,
      "width": 160,
      "height": 18
    }
  ],
  "form_fields": [
    {
      "name": "full_name",
      "type": "text"
    },
    {
      "name": "plan",
      "type": "dropdown",
      "options": [
        "Basic",
        "Pro"
      ]
    }
  ],
  "defaults": {
    "flatten": true
  },
  "created": "2026-10-11T18:10:40Z",
  "updated": "2026-10-11T18:10:40Z"
}
404No such file on this account, or it has expired
{
  "error": "string",
  "message": "string",
  "param": "string"
}
Try it — sign in first
Runs on a sandbox key: 200 requests a month. Your real key is for production.