Skip to main content
GET
LIST Page

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
leaseDocId
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:pageSequence

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

Available options:
pageSequence
sortDir
string
default:asc

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

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 document Pages on this page of results, ordered by pageSequence.

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.