Get a letter document template

Fetch one Word-document letter template together with a URL that serves its current .docx file.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

letterDocumentTemplateIdstringrequired

The letter document template to fetch. A 64-bit number sent as a string.

example: 1830538211944759296

idstringrequired

The letter document template. A 64-bit number sent as a string.

letterTemplateGroupIdstring

The group this template is filed under. Absent while it is ungrouped.

namestring

The name shown to the property manager. Absent when the template was created without one.

communicationChannelsenum<string>[]required

The kinds of recipient this template can be addressed to.

tenantownervendorleasemaintenanceRequestworkOrderrentalApplicationpropertyManagercompany

documentIdstringrequired

The document that holds the Word file behind this template. Pass it to nothing else in this reference — it is the handle the editor uses.

createdstring · date-timerequired

When the template was created, in the company's timezone and with no offset.

updatedstring · date-timerequired

When the template row was last changed, in the company's timezone and with no offset.

filePublicUrlstringrequired

A URL that serves the template's current .docx file. Fetched fresh on every call, so read it from the response rather than storing it.