Lease templates

List the data paths a template can use

Returns the tree of lease values a template of the given type can fill boxes from. Put a key from here into an annotation's dataPath. Unlike the document version, no lease is involved, so no values come back.

GET

https://api.portal.magicdoor.com/company-app/lease-templates/data-paths

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

typeenum<string>

Which kind of template the paths are for. Defaults to lease when left out.

default: leaseexample: leaseleaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation

Response

200 · The data paths available to that template type.

dataPathsDataPath[]

The tree of available values.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/lease-templates/data-paths?type=lease' \
  --header 'Authorization: Bearer <token>'

Response

{
  "dataPaths": [
    {
      "key": "lease",
      "name": "Lease",
      "type": "none",
      "children": [
        {
          "key": "lease.start",
          "name": "Start date",
          "type": "dateOnly"
        },
        {
          "key": "lease.rent",
          "name": "Monthly rent",
          "type": "currency"
        }
      ]
    }
  ]
}