Returns a paginated list of commercial tenancies within the API key's scope, most recently started first.

A tenancy either covers the whole building or a set of named units; whole-building
tenancies return an empty units array.

status is derived from the tenancy dates rather than stored: Upcoming has not
started, Active is running now, Finished has ended. A tenancy with no end date is
open-ended and stays Active. Use activeOn when you need to ask the same question
about a date other than today.

Rents are returned in full, in the frequency the agent recorded them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 2147483647
int32
1 to 100
int64

Only tenancies against this commercial property.

int64

Only tenancies held by this commercial party.

string
enum

Derived status, worked out from the tenancy dates against today's date. Applied as a
date comparison in the query, so it pages correctly.

Allowed:
date-time

Only tenancies running on this date — started on or before it, and either open-ended or
ending on or after it. Use this rather than status when you need a date other
than today. Supplying both narrows to tenancies matching each.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json