Retrieve all borrower accounts

get

https://api.ncinomortgage.com/users/borrowers

This endpoint will retrieve all borrower accounts for the company.

To filter the scope of records returned, leverage one or more of the query params found below. Email is a common parameter by which to filter.

By default, all borrower accounts are returned regardless of is_active status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Email by which to filter borrower accounts.

has_custom_consent

boolean

Consent status by which to filter borrower accounts.

is_active

boolean

Status by which to filter borrower accounts.

loan_officer_id

uuid

Loan officer's ID by which to filter borrower accounts.

page

integer

The page to retrieve.

page_size

integer

The number of records returned in each page.

created_after

date-time

The date which a resource must be created after to be returned.

created_before

date-time

The date which a resource must be created before to be returned.

updated_after

date-time

The date which a resource must be updated after to be returned.

updated_before

date-time

The date which a resource must be updated before to be returned.

Headers

X-Api-Version

string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

200Success