Skip to main content
GET
LIST Document

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
leaseId
string
required

Query Parameters

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:filename

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

Available options:
filename,
createdAt,
numberOfPages,
docCategory
sortDir
string
default:asc

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

Filter
filename
string

Case-insensitive contains match on the document filename.

Filter
docCategory
enum<string>

Case-insensitive exact match on the document category label; an unrecognized value returns no results.

Available options:
Main Lease Agreement,
Extension - Amendment,
Expansion - Amendment,
Contraction - Amendment,
Move - Amendment,
Correction - Amendment,
New Rights - Amendment,
Other - Amendment,
Commencement Letter,
Work Letter,
Lease Abstract,
Stacking Plan,
Floorplan,
Site Plan,
Letter of Credit,
Letter of Intent,
Certificate of Insurance,
Notices,
Termination Notices,
Assignment and Assumption Agreement,
Telecom/Antenna Agreement,
Storage Agreement,
Other,
Sublease Agreement,
Consent to Sublease,
Parking Agreement,
Licensing Agreement,
Guaranty,
Estoppel,
Management Office Agreement,
Loan Agreement,
Letter Agreement,
JV Agreement,
Closing Document,
Purchase & Sale Agreement,
Management Agreement,
Brokerage Listing Agreement,
Real Estate Tax Bills,
Capital Projects,
Service Agreement,
Subordination, Non-Disturbance and Attornment Agreement,
Ground Lease,
Memorandum of Lease,
Rent Roll
Filter
documentStatus
string

Case-sensitive exact match on the review status. 'processing' matches every document still in the AI pipeline.

Filter
numberOfPagesMin
integer<int32>

Minimum page count; inclusive.

Filter
numberOfPagesMax
integer<int32>

Maximum page count; inclusive.

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 Documents 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.