List loan programs (borrower-facing)

The loan programs your company offers to borrowers. Send an item's id
as loanProgram when you create or update a loan file on
/api/v4/loans.

Programs your company keeps for its own internal use are not in this
list. They have their own endpoint, /api/v4/loan-programs-internal.

Order. Sorted by id, ignoring upper and lower case. There is no
order you can configure for programs, so the sequence is steady and
predictable but it carries no meaning — sort by label yourself if
that reads better in your own screens.

Paging depends on who calls. Signed in as a person, or through MCP,
you get a page at a time with meta.pagination (read the size applied
from meta.pagination.perPage). A company API key (a tenant API key or a legacy
token) gets every row at once with meta.count, as this API has always
answered this list, and page, perPage and per_page are ignored.

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

Which page to return, counting from 1. Defaults to page 1.

Leaving this off does not return every row — every list on this API
is paged. See perPage for the size, and read
meta.pagination.perPage back rather than assuming it.

⚠️ One exception: the reference and directory lists (loan types, loan
programs, statuses, sub-statuses, brokers, loan officers, branches,
back-office employees) answer a company API key with every row and
ignore this parameter. People and MCP are paged there too.

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