List custom field definitions

The custom fields your company has set up. Read this before working
with custom field values, so you know which fields exist and which
id to use for each one.

You only see your own company's custom fields, and only the ones that
are switched on and made available to the API.

Match on id, never on label. A label is the name shown on
screen and can be renamed at any time. More importantly, several
fields can share one label
— that is normal, not a mistake in your
data, which is why each field also carries a key with its id on the
end, like email_697 and email_713. The numeric id is the only
value that is guaranteed to mean one field.

Where a field appears. placement tells you which screen a field
shows up on: loan for the loan file only, profile for the borrower
profile only, and loanAndProfile for fields that appear on each. A loanAndProfile
field holds two separate values — one stored against the loan and
one against the borrower. They are different records and can hold
different answers.

An empty list is a real answer. Your company may simply not have
set any custom fields up. You get a normal, empty list rather than an
error.

Order. Grouped by section in the order your sections are arranged,
then by the order the fields are arranged inside each section.

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

Narrows the list to the fields that appear on one screen. Use loan for the loan file only, profile for the borrower profile only, or loanAndProfile for the fields that appear on each. Leave it out to get every field. Any other value is refused.

Allowed:
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