Packet templates

A packet template defines the documents in a packet and the signer roles that fill them in. Templates are built in the DocRunner app. The API reads them and can archive or restore them.

Endpoints

Method	Path	Description
GET	/api/packet_templates	List packet templates
GET	/api/packet_templates/:id	Get a packet template
GET	/api/packet_templates/:id/archive	Archive a packet template
GET	/api/packet_templates/:id/restore	Restore a packet template

The packet template object

Summary fields

Field	Type	Description
id	integer	Template ID. Use it as packet_template_id when creating a packet.
name	string	Template name.
category	string	Category label.
description	string
test_mode	boolean	When true, packets from this template do not send email.
archived_at	timestamp
created_at	timestamp
updated_at	timestamp

Detail fields

Returned when you fetch a single template.

Field	Type	Description
slug	string	URL identifier for the template.
template_key	string
recipient_roles	array	The signer roles. Each has a key you use in roles when creating a packet, plus signing_order and max_count.
reminders_enabled	boolean
first_reminder_days	integer
repeat_reminders	boolean
repeat_interval_days	integer

List packet templates

GET /api/packet_templates

Accepts the standard list parameters. Archived templates are excluded unless you send filters[include_archived]=true.

curl https://app.docrunner.io/api/packet_templates \
  -H "X-API-Key: $DOCRUNNER_API_KEY"

{
  "packet_templates": [
    {
      "id": 9,
      "name": "Lease Packet",
      "category": "Leasing",
      "description": null,
      "test_mode": false,
      "archived_at": null,
      "created_at": "2026-03-01T15:00:00Z",
      "updated_at": "2026-04-02T18:30:00Z"
    }
  ],
  "meta": { "current_page": 1, "total_pages": 1, "total_count": 1, "per_page": 25 }
}

Get a packet template

GET /api/packet_templates/:id

curl https://app.docrunner.io/api/packet_templates/9 \
  -H "X-API-Key: $DOCRUNNER_API_KEY"

Returns 404 with { "error": "Packet Template 9 not found" } if the template is not in your account.

Archive and restore

GET /api/packet_templates/:id/archive
GET /api/packet_templates/:id/restore

An archived template cannot be used to create packets. Both endpoints return the template ID:

{ "packet_template": { "id": 9 } }