List branches

Lists the branches set up on your account. Each row is the short
version — id, branch name, company name, city, state, and whether the
branch is active. For the full profile, call
GET /api/v4/branches/{id}.

You get active branches only, unless you add includeInactive=true.
Use search to find a branch by its name, company, contact email or
manager's name rather than paging through the whole list.

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.

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 per_page for the size, and read
meta.pagination.perPage back rather than assuming it.

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 per_page=1 sizes a list before you fetch it, and
hasMore says whether more remain.

Responses

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