List back-office employees

Lists your back-office employees — your own staff, as opposed to an
outside broker or the borrower. Each row is the short version — id,
name, email, role, and whether the employee is active. For the full
profile, call GET /api/v4/back-office-employees/{id}.

You get active employees only, unless you add includeInactive=true.

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.

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