Skip to main content
GET
LIST Loan

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

Query Parameters

include
enum<string>[]

Optional collections to populate. Unknown keys are rejected with 400.

  • summary — adds the loan's consolidated summary terms, the values the loan page shows, with each container's child terms nested in its childTags. Covenants and reporting deliverables are left to their own include keys.
    • Requires the READ:TAG capability.
  • covenants — adds the loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in its childTags. A covenant struck by a later document is kept, with its rightIsStricken child.
    • Requires the READ:TAG capability.
  • deliverables — adds the loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in its childTags. A deliverable struck by a later document is kept, with its rightIsStricken child.
    • Requires the READ:TAG capability.
  • documents — adds per-document page geometry keyed by loanDocId, for resolving tagSelections[].docPageId references.
    • Requires the READ:DOCUMENT capability.
Available options:
summary,
covenants,
deliverables,
documents
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:name

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

Available options:
name,
closingDate
sortDir
string
default:asc

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

Filter
propertyId
string

Keep only loans with at least one collateral building in this property.

Filter
buildingId
string

Keep only loans with this building among their collateral.

Filter
name
string

Case-insensitive contains match on the loan name.

Filter
loanType
string

Case-insensitive exact match on the loan type, such as 'Construction Loan'; an unrecognized value returns no results.

Filter
borrower
string

Case-insensitive contains match on the borrower.

Filter
lender
string

Case-insensitive contains match on the lender's legal name.

Filter
closingAfter
string<date>

Loans closing on or after this calendar date (yyyy-MM-dd); inclusive. Loans with no closing date are left out.

Filter
closingBefore
string<date>

Loans closing on or before this calendar date (yyyy-MM-dd); inclusive. Loans with no closing date are left out.

Filter
status
enum<string>

Exact match on the loan's processing status, ignoring case: whether Prophia has read its documents, not whether the loan is active, matured or paid off. An unrecognized value is rejected.

Available options:
PENDING,
PROCESSING,
COMPLETE,
FAILED

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