Reference, v1

Templates

Calls are made to https://api.footer365.net with an API key as a bearer token. This page is generated from the API's own description, which you can download.

GET /v1/templates

Lists the templates the key can see

Every template of your organisation the key can see, by name, in one response. A template in a folder with its own access is listed only when that folder gives Everyone with View signatures access. Each shows its live version; draft is set when a change is saved beside it, waiting to be published or approved, and its content is not returned. Needs templates.read.

Answers 200 with TemplateList.

GET /v1/templates/{id}

Reads one template and its current version

One template with the HTML and plain text of its current version, the one mail is signed with, never a draft saved beside it, with merge tags such as {{DisplayName}} as they are written in the template. For a person's finished signature, use GET /v1/users/{user}/signature. Needs templates.read.

Parameter	In	Type	About it
`id`	path	string (uuid)	The template's id.

Answers 200 with TemplateDetail.

Types

`TemplateList`

Property	Type	About it
`items`	array of TemplateSummary	Each template, by name.

`TemplateDetail`

Property	Type	About it
`template`	TemplateSummary	The template.
`html`	string	The current version's HTML, with merge tags unresolved.
`text`	string	The current version's plain text, with merge tags unresolved.

`TemplateSummary`

Property	Type	About it
`id`	string (uuid)	The template's id.
`name`	string	Its name.
`description`	string, or null	Its description, or null.
`active`	boolean	Whether it is active, so rules can use it.
`usedByEnabledRule`	boolean	Whether an enabled rule sends it.
`folder`	ApiFolder, or null
`version`	integer, or null	The number of its current version, or null when it has none.
`createdAt`	string (date-time)	When it was made, in UTC.
`updatedAt`	string (date-time)	When it was last changed, in UTC.
`draft`	ApiDraft, or null

`ApiFolder`

Property	Type	About it
`id`	string (uuid)	The folder's id.
`name`	string	The folder's name.

`ApiDraft`

Property	Type	About it
`status`	string	Where it stands: draft, awaiting_approval or scheduled.
`savedAt`	string (date-time)	When it was last saved, in UTC.
`publishAt`	string (date-time), or null	When it is set to publish, in UTC, or null.

Errors are written the same way for every call; see Errors. Answers may gain fields within a version, so ignore any you do not recognise.