List brokers

Lists the brokers set up on your account. Each row is the short
version — id, name, email, company, and whether the broker is
active. For the full profile, including what the broker is allowed
to do, call GET /api/v4/brokers/{id}.

When GET /api/v4/me reports branchRestrictionsEnforced: true, the
list holds only brokers actively linked to one of your
assignedBranches. GET /api/v4/brokers/{id} is not limited.

You get active brokers only, unless you add includeInactive=true.
Use search to find someone by name, email or company rather than
paging through the whole list.

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
boolean

Set to true to also get records that have been deactivated or archived. Leave it out and you get active records only.

Narrow the list to records whose name, email or company contains this text — anywhere in it, ignoring case. For a branch, "name" is the branch's own name; the row carries no person.

The text is matched literally: % and _ are not wildcards, so 50% finds a company containing "50%" and a_b finds "a_b". There is no wildcard, prefix or exact-match mode.

Filtering happens before paging, so meta.pagination.total is the number of matches, not the size of the directory. A term that matches nothing is a normal empty result — 200 with an empty data and total: 0 — not an error. Leaving it out, or sending an empty string, applies no filter at all and returns everything.

Which fields are matched, per list: brokers and loan officers — first name, last name, email, company; branches — branch name, company, contact email, and the branch manager's first and last name; back-office employees — first name, last name, email. The rule is every identity column the resource has, not every column its list row shows.

⚠️ A matched branch may show nothing that explains the match. Three of those five branch fields — the contact email and the two manager names — are on GET /api/v4/branches/{id}, not in the list row. So search=Robert can return a branch whose branchName, companyName, city and state contain no "Robert". That is correct: fetch the branch by its id to see why it matched. Searching only the list fields was the worse option — a branch you can find by its manager through the detail endpoint would be unfindable from the list.

Longer than 255 characters is a 422, not a silent empty list.

⚠️ A company API key (a tenant API key or a legacy token) sends search to no effect, as these lists have always answered it: the whole list comes back whatever it says, a value over 255 characters is not a 422, and it is not named in meta.warnings. Neither is archive_state, which no directory reads. Signed in as a person, or through MCP, search filters as described above.

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