Search portfolios, properties, units and leases

Runs one free-text search across the company's portfolios, properties, units and leases, and returns the matches nested in that order. Built for a picker that drills down from portfolio to lease.

POST

https://api.portal.magicdoor.com/company-app/search/select

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.

Body

application/json

searchstringrequired

What to search for, 1 to 150 characters.

levelSearchenum<string>

How deep to search and therefore how deep the result nests. portfolio stops at portfolios, lease goes all the way down.

default: leaseportfoliopropertyunitlease

includeTenantsboolean

Whether to also return the tenants on each matched lease.

default: false

includeEndedLeasesboolean

Whether to include leases that have been closed out.

default: false

includeDeactivatedboolean

Whether to include deactivated portfolios, properties and units.

default: false

includeFutureLeaseboolean

Whether to include leases that have not started yet.

default: true

excludeUnlistedUnitboolean

Whether to leave out units that are not listed for rent.

default: false

Response

200 · The matches, nested portfolio to property to unit to lease.

portfoliosobject[]

Matched portfolios, each carrying whatever matched beneath it.

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

It is a POST because of the body, not because it changes anything

This endpoint reads only. It takes a POST so the seven options can be sent as JSON rather than crammed into a query string.

The nesting always follows portfolio, property, unit, lease. levelSearch decides where it stops: a levelSearch of property returns portfolios with properties inside them and no units array at all.

Request

curl --request POST \
  --url 'https://api.portal.magicdoor.com/company-app/search/select' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "search": "pine",
  "levelSearch": "lease",
  "includeTenants": true
}'

Body

{
  "search": "pine",
  "levelSearch": "lease",
  "includeTenants": true
}

Response

{
  "portfolios": [
    {
      "portfolio": {
        "id": "1830472847398401001",
        "active": true,
        "name": "Downtown",
        "propertyCount": 12,
        "icons": []
      },
      "properties": [
        {
          "property": {
            "id": "1830472847398402002",
            "name": "Pine Street Duplex",
            "displayName": "Pine Street Duplex",
            "address": {
              "streetAddress1": "412 W Pine St",
              "city": "Missoula",
              "state": "MT",
              "zipCode": "59802",
              "country": "US",
              "isValid": true
            },
            "portfolioId": "1830472847398401001",
            "type": "multiFamily",
            "unitCount": 2,
            "recentRentalApplications": 0,
            "active": true,
            "icons": []
          },
          "units": [
            {
              "unit": {
                "id": "1830472847398403003",
                "name": "A",
                "address": {
                  "streetAddress1": "412 W Pine St",
                  "city": "Missoula",
                  "state": "MT",
                  "zipCode": "59802",
                  "country": "US",
                  "isValid": true
                },
                "beds": 2,
                "baths": 1,
                "unitSizeSqft": 880,
                "marketRent": 1850,
                "propertyId": "1830472847398402002",
                "portfolioId": "1830472847398401001",
                "active": true,
                "icons": []
              },
              "leases": [
                {
                  "lease": {
                    "id": "1830472847398404096",
                    "portfolioId": "1830472847398401001",
                    "propertyId": "1830472847398402002",
                    "unitId": "1830472847398403003",
                    "start": "2026-01-01",
                    "end": "2026-12-31",
                    "ended": false,
                    "monthToMonth": false,
                    "eviction": false,
                    "chatId": "1830472847398405005",
                    "tenants": [
                      {
                        "tenantId": "1830472847398406006",
                        "moveIn": "2026-01-01"
                      }
                    ],
                    "balance": 1850,
                    "currentRent": 1850,
                    "securityDepositPaid": 1850,
                    "securityDepositRequested": 1850,
                    "securityDepositDue": 0,
                    "lastPaymentDate": "2026-02-02",
                    "earliestUnpaidBillDueDate": "2026-03-01",
                    "icons": [],
                    "draft": false,
                    "status": "lease",
                    "expiringStatus": "none",
                    "pastDueDays": 3,
                    "postedBalance": 1850
                  },
                  "tenants": [
                    {
                      "id": "1830472847398406006",
                      "active": true,
                      "email": "sam@example.com",
                      "firstName": "Sam",
                      "lastName": "Ortiz",
                      "phone": "(406) 555-0188",
                      "created": "2025-12-02T10:11:00",
                      "updated": "2026-01-02T08:00:00",
                      "portalStatus": "active",
                      "language": "en",
                      "icons": []
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}