Get template

Returns one template by ID. The response includes the parsed field manifest (field_metadata) and version state.

Signature

GET /api/v1/templates/{template_id}

Permissions

API key scope: read or higher. Caller must own the template, be a member of the owning organization, or have an explicit share grant.

Path parameters

Name	Type	Description
`template_id`	integer	Template ID returned by Upload template.

Example

curl https://api.simplyfill.app/v1/templates/123 \
  -H "Authorization: Bearer $SIMPLYFILL_API_KEY"

const template = await client.templates.get(123)
console.log(Object.keys(template.field_metadata))

template = client.templates.get(123)
print(list(template.field_metadata.keys()))

Response

{
  "id": 123,
  "name": "Invoice Template",
  "description": "Standard invoice",
  "filename": "invoice.pdf",
  "storage_path": "templates/abc.../invoice.pdf",
  "field_metadata": {
    "invoice_number": { "type": "text", "required": true, "max_length": 64 },
    "customer_name":  { "type": "text" },
    "total_amount":   { "type": "text" },
    "due_date":       { "type": "date" }
  },
  "field_count": 4,
  "current_version": 3,
  "draft_status": "published",
  "default_environment": "production",
  "environment_versions": { "development": 4, "staging": 4, "production": 3 },
  "created_at": "2026-04-12T18:11:02Z",
  "updated_at": "2026-05-09T20:44:18Z"
}

Errors

Status	`error` code	Cause
`404`	`template_not_found`	No template with the given ID, or you lack access.

Get template

On this page