List branches

get

https://api.lendingwise.com/api/v4/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeInactive

boolean

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

page

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.

per_page

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

200Your branches. An empty list when you have none.

400Your request body could not be read, so nothing was changed. error.details.reason says what the problem was.

401Your bearer token is missing, or it is not valid. Get a new one from POST /api/v4/authenticate and send it again.

415Your body is JSON, but it was not labelled as JSON, so it was not read and nothing was changed. Send it again with Content-Type: application/json.

422One or more of the values you sent cannot be used, so nothing was changed. error.fields names each field and says what was wrong.

429You have made too many calls, so this one was refused and nothing was changed. Retry-After says how many seconds to wait; sending the same request again after that works.

defaultAny other failure. The shape is the same as every other error reply, so the same code can read it.