Lease documents

List lease documents

Returns a page of lease documents across the company, with the leases, units, properties and stored files they refer to alongside. Filter by lease to see one tenancy's paperwork.

GET

https://api.portal.magicdoor.com/company-app/lease-documents

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. Starts at 1.

default: 1example: 1

pageSizeinteger

How many rows per page, between 1 and 100.

default: 50example: 50

leaseIdstring

Only documents on this lease. A Snowflake id, sent as a decimal string.

unitIdstring

Only documents on leases at this unit. A Snowflake id, sent as a decimal string.

propertyIdstring

Only documents on leases at this property. A Snowflake id, sent as a decimal string.

portfolioIdstring

Only documents on leases in this portfolio. A Snowflake id, sent as a decimal string.

statusenum<string>

Only documents in this state.

draftpendingSignaturescompletedretracted

Response

200 · A page of lease documents.

itemsLeaseDocument[]

The rows on this page.

currentPageinteger

The page you asked for. Pages start at 1.

totalPagesinteger

How many pages exist at this page size.

pageSizeinteger

How many rows a page holds.

totalCountinteger

How many rows match in total, across all pages.

propertiesProperty[]

The properties the documents' leases are on.

unitsUnit[]

The units the documents' leases are on.

leasesLease[]

The leases the documents belong to.

filesFile[]

The stored PDFs the documents point at.

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.

The signing flow

A lease document starts as a draft. Place the signature and text boxes on it with the update endpoint, then call begin-signing to send it out, which moves it to pendingSignatures. Once every signer has signed it becomes completed. Retracting pulls it back out of signing.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/lease-documents?page=1&pageSize=50' \
  --header 'Authorization: Bearer <token>'

Response

{
  "items": [
    {
      "id": "1842019384756201984",
      "portfolioId": "1827741029384756224",
      "propertyId": "1829933847562019840",
      "unitId": "1832019384756201984",
      "leaseId": "1830472847398404096",
      "leaseTemplateIds": [
        "1843019384756201984"
      ],
      "fileId": "1838475620198404096",
      "name": "Residential lease agreement",
      "status": "draft",
      "type": "lease",
      "signers": [
        {
          "id": "1831856473920184832",
          "name": "Dana Whitfield",
          "type": "tenant",
          "signatureStatus": "draft",
          "signatureName": "Dana Whitfield",
          "signatureInitials": "DW",
          "emailSignature": {
            "destination": "dana.whitfield@example.com",
            "type": "email",
            "sentDate": "2026-02-24T13:10:00"
          }
        }
      ],
      "annotations": [
        {
          "id": "sig-tenant-1",
          "signerId": "1831856473920184832",
          "page": 6,
          "x": 0.12,
          "y": 0.72,
          "width": 0.3,
          "height": 0.06,
          "fontSize": 12,
          "type": "signature",
          "isInputField": true,
          "isVisible": true,
          "isMandatory": true
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "pageSize": 50,
  "totalCount": 9,
  "properties": [
    {
      "id": "1829933847562019840",
      "name": "Elm Street Apartments",
      "displayName": "Elm Street Apartments",
      "address": {
        "streetAddress1": "418 Elm Street",
        "city": "Portland",
        "state": "OR",
        "zipCode": "97204",
        "country": "US",
        "isValid": true
      },
      "portfolioId": "1827741029384756224",
      "type": "multiFamily",
      "unitCount": 24,
      "recentRentalApplications": 3,
      "active": true,
      "icons": []
    }
  ],
  "units": [
    {
      "id": "1832019384756201984",
      "name": "4B",
      "address": {
        "streetAddress1": "418 Elm Street",
        "city": "Portland",
        "state": "OR",
        "zipCode": "97204",
        "country": "US",
        "isValid": true
      },
      "beds": 2,
      "baths": 1,
      "unitSizeSqft": 880,
      "marketRent": 1850,
      "floor": 4,
      "propertyId": "1829933847562019840",
      "portfolioId": "1827741029384756224",
      "active": true,
      "icons": []
    }
  ],
  "leases": [
    {
      "id": "1830472847398404096",
      "portfolioId": "1827741029384756224",
      "propertyId": "1829933847562019840",
      "unitId": "1832019384756201984",
      "start": "2026-03-01",
      "end": "2027-02-28",
      "ended": false,
      "monthToMonth": false,
      "eviction": false,
      "chatId": "1830472847398500000",
      "balance": 1850,
      "postedBalance": 1850,
      "currentRent": 1850,
      "securityDepositPaid": 1850,
      "securityDepositRequested": 1850,
      "securityDepositDue": 0,
      "lastPaymentDate": "2026-07-01",
      "earliestUnpaidBillDueDate": "2026-08-01",
      "pastDueDays": 16,
      "icons": [],
      "draft": false,
      "status": "lease",
      "expiringStatus": "none",
      "tenants": [
        {
          "tenantId": "1831856473920184832",
          "moveIn": "2026-03-01"
        }
      ]
    }
  ],
  "files": [
    {
      "id": "1838475620198404096",
      "created": "2026-08-14T10:22:41",
      "name": "lease-agreement.pdf",
      "extension": "pdf",
      "size": 284193,
      "contentType": "application/pdf",
      "secureUrl": {
        "base": "https://files.magicdoor.com",
        "raw": "/f/1838475620198404096/raw",
        "variantTemplate": "/f/1838475620198404096/{variant}"
      },
      "fileId": "1838475620198404096",
      "fileName": "lease-agreement.pdf",
      "signedUrl": "https://files.magicdoor.com/f/1838475620198404096/raw?sig=abc123",
      "fileSize": 284193,
      "uploaded": "2026-08-14T10:22:41",
      "claimed": true
    }
  ]
}