Signing templates

Get a signing template

Fetches one signing template together with the URL of its current Word file, which is what the document editor opens.

GET
https://api.portal.magicdoor.com/company-app/signing-templates/{signingDocumentTemplateId}

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.

Path parameters

signingDocumentTemplateIdstringrequired

The signing template to act on. A Snowflake id sent as a decimal string.

example: 1830472847398423023

Response

200 · The template and its editor file.

idstring

The signing template. A Snowflake id sent as a decimal string.

companyIdstring

The company the template belongs to.

documentIdstring

The underlying document record that holds the Word file and its placeholders.

namestring

Name of the template. Absent when none was given.

templateTypeenum<string>

What kind of document the template produces.

leaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation
leaseTemplateCategoryIdstring

The category the template is filed under. Absent when it is uncategorised.

docxUrlstring

URL of the current Word file, for opening in the document editor.

createdstring · date-time

When the template was created, in the company's timezone.

updatedstring · date-time

When it was last changed, in the company's timezone.

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

404 · No signing template with that id exists in the caller's company.