MagicDoorAPI
SupportOpen MagicDoor
Notes

List notes on a record

Returns a page of the internal notes your team has written on one lease, tenant, property, or other record.

GET
https://api.portal.magicdoor.com/company-app/notes/{entityType}/{entityId}

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

entityTypeenum<string>required

What kind of record the notes are attached to. Matched without regard to case, so lease and Lease both work.

example: leaseleaseunitpropertyportfoliocompanytenantvendorownerpropertyManagermaintenanceRequestworkOrderbilltransactionrentalApplication
entityIdstringrequired

The record the notes are attached to — a lease id when entityType is lease, a tenant id when it is tenant, and so on.

example: 1829833104612495360

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1example: 1
pageSizeinteger

How many items to return per page. Between 1 and 100.

default: 50example: 25
typeenum<string>

Only return notes of this kind.

notedelinquency

Response

200 · One page of notes.

itemsNote[]

The notes.

currentPageinteger

The page number that was returned.

totalPagesinteger

How many pages exist at this page size.

pageSizeinteger

How many items a page holds.

totalCountinteger

How many items match in total, across every page.

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

Notes are internal to your team. Nothing here is shown to a tenant, owner, or vendor, and no message is sent.

content is cut off at 500 characters in this list. Fetch a note by id to read it in full.