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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

