MagicDoorAPI
SupportOpen MagicDoor
Letter document templates

List letter document templates

Returns a page of the company's Word-document letter templates, newest first. The document's file URL is not included here — fetch a single template to get one.

GET
https://services.magicdoor.com/communications/company-portal/letter-templates/documents

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.

Query parameters

pageinteger

Which page to return, counting from 1.

default: 1example: 1
pageSizeinteger

How many records to return. Between 1 and 100; anything outside that range is rejected with a 400.

default: 50example: 50
channelsenum<string>[]

Keep only templates that can be addressed to at least one of these kinds of recipient. Repeat the parameter for more than one value. Omit it and every template is returned.

tenantownervendorleasemaintenanceRequestworkOrderrentalApplicationpropertyManagercompany

Response

200 · A page of letter document templates.

itemsLetterDocumentTemplate[]

The templates on this page, newest first.

totalCountinteger

How many records match the filters, across every page.

totalPagesinteger

How many pages of this size the matching records fill.

pageinteger

The page that was returned.

pageSizeinteger

How many records were asked for per page.

400 · `page` is below 1, or `pageSize` is outside 1 to 100.

401 · The access token is missing, expired, or not a property-manager token.

A letter document template is a Word document rather than an email body: MagicDoor keeps the .docx itself, and the property manager edits it in a document editor.