Letter templates

List letter templates

Returns a page of the company's letter templates, newest first, with their email and chat content exactly as written — placeholders unresolved.

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

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, for example ?channels=tenant&channels=lease. Omit it and every template is returned.

tenantownervendorleasemaintenanceRequestworkOrderrentalApplicationpropertyManagercompany
letterTemplateGroupIdstring

Keep only templates filed under this group. A 64-bit number sent as a string.

isImportedboolean

true keeps only templates that came from an uploaded Word file, false only those written in MagicDoor. Omit it and both are returned.

Response

200 · A page of letter templates.

itemsLetterTemplate[]

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.