Lease documents

List a document's data paths and values

Returns the tree of lease values available to this document's boxes — tenant names, rent, dates and so on — each with the key you put in an annotation's dataPath and the value it currently resolves to.

GET

https://api.portal.magicdoor.com/company-app/lease-documents/{leaseDocumentId}/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.

Path parameters

leaseDocumentIdstringrequired

The document whose data paths you want. A Snowflake id, sent as a decimal string.

example: 1842019384756201984

Response

200 · The data paths and their current values.

dataPathsDataPath[]

The tree of available values.

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

404 · No lease document matched the id, or it belongs to another company.

Request

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

Response

{
  "dataPaths": [
    {
      "key": "lease",
      "name": "Lease",
      "type": "none",
      "children": [
        {
          "key": "lease.start",
          "name": "Start date",
          "type": "dateOnly",
          "text": "March 1, 2026"
        },
        {
          "key": "lease.rent",
          "name": "Monthly rent",
          "type": "currency",
          "text": "$1,850.00"
        }
      ]
    }
  ]
}