List loan files

Lists the loan files on your processing company's account, as short
summary rows rather than the full detail of each one.

Archived files are left out by default. Two parameters change that and
they are not the same: includeArchived=true adds archived files to
the active ones, while archiveState selects — archived for
archived only, active for active only, all for both. Sending both is
allowed and archiveState wins; includeArchived is then ignored
rather than rejected. archiveState takes only those three words, and
any other value is a 422 — a silently dropped archived would return
the active list with a 200.

You can also narrow the list by broker, borrower, or loan officer, by
pipeline status, by created/modified date, by loan number
(loanNumber), or by a free-text term over the borrower's name and
email, the loan number and the property address (search) — and walk
through it with page and perPage.

Every filter applies BEFORE paging, so meta.pagination.total is the
size of the FILTERED set and never of the page or of the whole
pipeline.

⚠️ A company API key (a tenant API key or a legacy token) sends
search, archiveState (or archive_state), primaryStatusId (or
primary_status_id) and perPage to no effect, as this API has always
answered it: none of them narrows or resizes the list (a page is 25
rows unless per_page says otherwise), a value they would refuse is
not a 422, and none is named in meta.warnings. per_page, page,
includeArchived and the other filters apply as described. Signed in as
a person, or through MCP, every parameter works as described above.

Your branches. When this API limits people by branch and
GET /api/v4/me reports branchRestrictionsEnforced: true, the rows
and meta.pagination.total cover only the loans filed under the
branches it lists in assignedBranches. branchId narrows within
those branches and never widens them: a branch outside them gives an empty page with total: 0,
not an error. A company API key always sees the whole company.

Rows are ordered by loan-file id, highest first, and that order is
stable across pages — page 2 continues below page 1 with no overlap.
The most recently created file is therefore the first row of page 1,
so finding it takes one request rather than a walk of every page.
There is no sort parameter; this is the only ordering available.

createdDate is not the sort key and can disagree with it: a file whose
createdDate holds an earlier date than the row beneath it still sorts
by its id. To order by date, read createdDate from the rows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Restrict to loans whose originating broker (brokerNumber) matches.

integer
deprecated

Deprecated — use brokerId. Still accepted, and means exactly what brokerId means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

integer

Restrict to loans for a borrower client id (CID).

integer
deprecated

Deprecated — use borrowerId. Still accepted, and means exactly what borrowerId means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

integer

Restrict to loans assigned to a loan officer.

integer
deprecated

Deprecated — use loanOfficerId. Still accepted, and means exactly what loanOfficerId means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

boolean

ADD archived (inactive) files to the active ones. Additive, never selective — for archived-only use archiveState=archived. Ignored when archive_state is also sent. Defaults to active-only.

boolean
deprecated

Deprecated — use includeArchived. Still accepted, and means exactly what includeArchived means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

string
enum

Select files by archive state: archived returns archived files ONLY, active returns active files only (the same set as the default), all returns both. Overrides includeArchived when both are sent. Any other value is a 422. Ignored, whatever its value, for a company API key (see the description above).

Allowed:
string
enum
deprecated

Deprecated — use archiveState. Still accepted, and means exactly what archiveState means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

Allowed:
primaryStatusId
array of integers
length ≤ 50

Restrict to loans on one or more pipeline statuses, by the id from GET /api/v4/loan-primary-statuses. Several ids go in one comma-separated value (?primaryStatusId=57448,100735), up to 50. Ids only — a label, a negative, 0, or an empty element (1,,2) is refused with 422. ⚠️ 0 is refused because it is the never-set default rather than a status id, and every row it could match reads back with primaryStatusId: null. ⛔ PER-STATUS COUNTS DO NOT SUM TO meta.pagination.total: files that report primaryStatusId: null — no status was ever recorded — are in no status bucket, so they appear in no filtered result. Size the whole list with a separate unfiltered perPage=1 call. Ignored, whatever its value, for a company API key (see the description above).

primaryStatusId
primary_status_id
array of integers
length ≤ 50
deprecated

Deprecated — use primaryStatusId. Still accepted, and means exactly what primaryStatusId means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

primary_status_id
date

Earliest createdDate to include, as YYYY-MM-DD. INCLUSIVE, and usable without createdTo to mean "since this date". Only that exact format is accepted — now, +1 week and 2026-06-01T00:00:00Z are refused with 422, so an answer is reproducible tomorrow.

date
deprecated

Deprecated — use createdFrom. Still accepted, and means exactly what createdFrom means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

date

Latest createdDate to include, as YYYY-MM-DD. INCLUSIVE of the whole day, and usable without createdFrom. A backwards range (createdFrom after createdTo) is a 422 naming createdTo — the same rule on every date-range filter of this API. (Until API 4.1 it was an empty list with 200.)

date
deprecated

Deprecated — use createdTo. Still accepted, and means exactly what createdTo means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

date

Earliest last-modified date to include, as YYYY-MM-DD. INCLUSIVE, and usable on its own. ⚠️ THE MODIFIED DATE IS NOT RETURNED IN THE ROWS — it is read for filtering only, so you cannot check a row's value against the window you asked for. ⛔ A FILE WITH NO RECORDED MODIFICATION DATE IS OUTSIDE EVERY WINDOW, one-sided ones included. It is not "unmodified, therefore old" — it is absent from the answer. A small minority of files are in this state. A loan created through this API and never updated is NOT one of them: it carries its creation time as its modified date.

date
deprecated

Deprecated — use modifiedFrom. Still accepted, and means exactly what modifiedFrom means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

date

Latest last-modified date to include, as YYYY-MM-DD. INCLUSIVE of the whole day — a file modified at 23:59:59 on this date is returned — and usable on its own. A backwards range (modifiedFrom after modifiedTo) is a 422 naming modifiedTo.

date
deprecated

Deprecated — use modifiedTo. Still accepted, and means exactly what modifiedTo means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

string
length ≤ 255

Restrict to loans whose loanNumber CONTAINS this text. Matching is case-insensitive and by SUBSTRING, so a partial number works — 000123 finds LN-000123-A. The value is matched LITERALLY: % and _ are not wildcards, so a loan number containing either can be pasted verbatim. ⛔ A LOAN NUMBER IS NOT UNIQUE — not even within one processing company — and a substring match widens that further, so this is a FILTER and not a lookup: expect more than one row and read meta.pagination.total. An unmatched value is an empty list with 200, never an error; an empty or blank value means "not filtering" and returns the unfiltered list.

string
length ≤ 255
deprecated

Deprecated — use loanNumber. Still accepted, and means exactly what loanNumber means, until it is removed on a date announced in the API changelog, 90 days after the announcement. A request that sends it gets a Deprecation response header; sending both names with different values is a 422 naming both.

One free-text term, matched case-insensitively and by SUBSTRING across the borrower's first name, last name and email, the loan number, and the property address. The value is matched LITERALLY (% and _ are not wildcards) and as ONE piece of text — there is no OR across words and no phrase syntax. ⚠️ THE PROPERTY ADDRESS IS NOT A FIELD IN THE RETURNED ROWS, so a matched row can show nothing that explains why it matched. It is not bad data — read the property with GET /api/v4/loans/{id}. The address is read from BOTH the file's own address and the loan's property records, because the two can disagree in either direction. Narrows alongside every other parameter here rather than replacing one; loanNumber and search sent together AND with each other. An empty or blank value means "not filtering". Over 255 characters is a 422. Ignored, whatever its value, for a company API key (see the description above).

integer
≥ 1

Restrict to loans on one branch, by its id. ⛔ 0 is refused with 422 rather than treated as a branch: it is the never-assigned default, and every file carrying it reads back with branchID: null. When your access is limited to your branches, this narrows within them and never widens them: a branch outside them gives an empty page with total: 0.

string
length ≤ 50

Restrict to loans carrying ONE loan-type code (moduleCode), matched case-insensitively — hmlo and HMLO select the same files. ⚠️ A file can carry SEVERAL loan types, so this matches a file holding this one AMONG possibly others; the row's own fileType array then lists more codes than the one you asked for. That is the filter working, not a leak. One code only — there is no comma-separated form here.

string
length ≤ 50

Restrict to loans on one lending program, by the EXACT program code from GET /api/v4/loan-programs. Unlike fileType this is matched exactly, case included. ⚠️ Files still holding the TBD placeholder are matched by no program value — they read back with loanProgram: null.

date

Earliest loanClosingDate to include, as YYYY-MM-DD. INCLUSIVE, and usable without loanClosingTo to mean "closing on or after this date". Same format rule as createdFrom: only YYYY-MM-DD is accepted. ⛔ A FILE WITH NO CLOSING DATE RECORDED IS OUTSIDE EVERY WINDOW, one-sided ones included — it is absent from the answer, not "not yet closing, therefore later".

date

Latest loanClosingDate to include, as YYYY-MM-DD. INCLUSIVE of the whole day, and usable on its own. A backwards range (loanClosingFrom after loanClosingTo) is a 422 naming loanClosingTo. (Until API 4.1 it was an empty list with 200.)

number
≥ 0

Lowest loanTotalLoanAmount to include. INCLUSIVE, and usable without loanTotalLoanAmountMax. ⛔ A FILE THE PLATFORM HAS NOT CALCULATED AN AMOUNT FOR IS OUTSIDE EVERY RANGE, this one included. It reads back with loanTotalLoanAmount: null, and loanTotalLoanAmountMin=0 does NOT reach it — so amount-filtered counts do not sum to the unfiltered total, the same way per-status counts do not.

number
≥ 0

Highest loanTotalLoanAmount to include. INCLUSIVE, and usable on its own. Negative values are refused with 422.

integer
≥ 1

Restrict to loans a back-office employee is assigned to, by user id. A file commonly carries SEVERAL employees, so this matches a file holding this one AMONG others — the same "any one of" relationship subStatusId has to a file's several sub-statuses. Employees removed from the file no longer match. ⛔ 0 is refused with 422.

subStatusId
array of integers
length ≤ 50

Restrict to loans holding one or more sub-statuses, by the id from GET /api/v4/loan-sub-statuses or from a row's subStatuses[].id. Several ids go in one comma-separated value (?subStatusId=306208,306200), up to 50. Several ids match the UNION — a file holding ANY one of them — and a file commonly carries OTHERS besides, because sub-statuses are a checklist rather than a single field. ⚠️ EXCEPT FOR A FEW COMPANIES, where several ids mean ALL of them: a file must hold every id sent to match. This is a long-standing per-company customisation of the back office, reproduced here so the API and the back office answer the same question the same way; it applies to the same companies in both. A company is never switched silently — if your multi-id results look narrower than the union, this is why. ⚠️ ONE id sent ONCE behaves identically under both readings. ⛔ A REPEATED id DOES NOT: the threshold counts the ids you SENT, not the distinct ones, so ?subStatusId=5,5 asks a configured company for TWO distinct sub-statuses and therefore matches NOTHING, while every other company reads it as the single id 5 and matches normally. That is main's own behaviour, reproduced rather than corrected. ⭐ Send each id once and the two readings differ only in ANY-vs-ALL, which is the only difference worth reasoning about. Ids only: a label, a negative, 0, or an empty element (1,,2) is refused with 422.

subStatusId
integer
≥ 1

1-based page number.

integer
1 to 100

How many rows you want per page, from 1 to 100.

Omitted, it falls back to a server-configured default (25 today).
Read the size actually applied from meta.pagination.perPage rather
than assuming this number — it is configuration, not contract, and it
has already changed once.

The number of rows in data is therefore the size of the PAGE, never
of the list. meta.pagination.total is the size of the whole list, so
a single call with perPage=1 sizes a list before you fetch it, and
hasMore says whether more remain.

⚠️ On the reference and directory lists a company API key gets every
row and this parameter is ignored, a value above 100 included.

integer
1 to 100
deprecated

Deprecated — use perPage. Removed on a date announced in the API
changelog, 90 days after the announcement; until then it is accepted and
means exactly what perPage means.

A request that sends it gets a Deprecation response header. Sending
both names with different values is a 422 naming both; with the same
value it is one value. A bad value is reported under per_page, the
name you sent.

⚠️ On the reference and directory lists a company API key gets every
row: this parameter is ignored there, with no Deprecation header.

Responses

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