Skip to main content
GET
LIST Lease

Filters

Filters combine with AND: a result must match every filter you supply.

Authorizations

X-API-Key
string
header
required

Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.

Path Parameters

accountId
string
required
buildingId
string
required

Query Parameters

include
enum<string>[]

Optional collections to populate. Note: combining tags and documents on a heavily-tagged lease can produce a very large response — prefer requesting one at a time. Unknown keys are rejected with 400.

  • tags — adds the consolidated DocTag list extracted from this lease's documents (rent, options, dates, etc.).
    • Requires the READ:TAG capability.
  • documents — adds per-document page geometry keyed by leaseDocId, for resolving tagSelections[].docPageId references.
    • Requires the READ:DOCUMENT capability.
  • subleases — adds the list of subleases of this lease as lightweight refs (id, url, current leaseStatus and leaseSubStatus); empty when the lease has no subleases.
Available options:
tags,
documents,
subleases
page
integer<int32>
default:0

0-based page index. Negative values are clamped to 0.

limit
integer<int32>
default:50

Page size. Values outside 1–200 are clamped, not rejected; check the response's limit for the value actually applied.

sortBy
enum<string>
default:dba

Sort field. Defaults to dba; unrecognized values silently fall back to the default.

Available options:
dba,
tenantLegalName,
expirationDate,
commenceDate,
leaseStatus,
leaseType,
suiteNumber,
squareFootage,
customId
sortDir
string
default:asc

Sort direction: asc (default) or desc. Any other value is treated as asc.

Filter
status
enum<string>

Exact match on the lease status; an unrecognized value returns no results.

Available options:
Active,
Expired,
Not Started
Filter
tenantName
string

Case-insensitive contains match against both the tenant DBA and the tenant legal name.

Filter
expirationBefore
string<date>

Leases expiring on or before this calendar date (yyyy-MM-dd); inclusive.

Filter
expirationAfter
string<date>

Leases expiring on or after this calendar date (yyyy-MM-dd); inclusive.

Filter
leaseType
enum<string>

Filter by lease type. Matching is case-insensitive; an unrecognized value returns no results.

Available options:
OFFICE,
GSA_OFFICE,
RETAIL,
INDUSTRIAL,
STORAGE,
LICENSE_AGREEMENT,
TELECOM_ANTENNA,
PARKING_AGREEMENT,
ROOFTOP_SOLAR
Filter
suiteNumber
string

Case-insensitive contains match on the lease's suite names.

Filter
commenceBefore
string<date>

Leases commencing on or before this calendar date (yyyy-MM-dd); inclusive.

Filter
commenceAfter
string<date>

Leases commencing on or after this calendar date (yyyy-MM-dd); inclusive.

Filter
squareFootageMin
integer<int32>

Minimum square footage; inclusive.

Filter
squareFootageMax
integer<int32>

Maximum square footage; inclusive.

Filter
customId
string

Exact match on the lease's custom id.

Response

OK

totalCount
integer<int64>

Total number of items matching the request across all pages.

page
integer<int32>

0-based index of this page.

limit
integer<int32>

Page size actually applied — requested values outside 1–200 are clamped.

items
object[]

The Leases on this page of results.

hasMore
boolean

True when more pages exist after this one. Iterate on this rather than computing page counts from totalCount, which can change between requests.