Signing templates

List the placeholders a template can use

Returns every placeholder key that can be written into a template of a given kind: the data keys that get filled from the lease, unit, property and company, and the signature keys that mark where someone signs.

GET
https://api.portal.magicdoor.com/company-app/signing-templates/keys

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

templateTypeenum<string>required

Which kind of template to list keys for. Different kinds expose different keys.

example: leaseleaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation

Response

200 · The placeholder keys, as a plain array.

keystring

The placeholder to write into the Word file, for example unit/address/city.

namestring

Human-readable name for the key.

descriptionstring

What the key is filled with. Absent when there is no description.

groupstring

Which group the key belongs to, so the editor can list keys under headings.

kindstring

Data for a key filled from MagicDoor's records, Signature for a key that marks where someone signs. PascalCase, not camelCase.

401 · The access token is missing, expired, or not valid for this company.

`kind` is PascalCase

Most enums in this API come back camelCased. This one does not: it is turned into a string by hand, so you get Data and Signature, not data and signature.

The list is computed from the template type, not stored, so it is the same for every company. It does not need an id and does not touch the database.