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: include_archived=true adds archived files to
the active ones, while archive_state selects — archived for
archived only, active for active only, all for both. Sending both is
allowed and archive_state wins; include_archived is then ignored
rather than rejected. archive_state 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, and
walk through it with page and per_page.

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.

createdAt is not the sort key and can disagree with it: a file whose
createdAt holds an earlier date than the row beneath it still sorts
by its id. To order by date, read createdAt 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

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

integer

Restrict to loans assigned to a loan officer.

boolean

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

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 include_archived when both are sent. Any other value is a 422.

Allowed:
primary_status_id
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 (?primary_status_id=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 per_page=1 call.

primary_status_id
date

Earliest createdAt to include, as YYYY-MM-DD. INCLUSIVE, and usable without created_to 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

Latest createdAt to include, as YYYY-MM-DD. INCLUSIVE of the whole day, and usable without created_from. A backwards range (created_from after created_to) is an empty list with 200, not an error.

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

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.

integer
≥ 1

1-based page number.

integer
1 to 100

Rows per page, 1 to 100. Omitted, a server-configured default applies (25 today) — read meta.pagination.perPage for the size actually used.

Responses

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