GuidesRecipesAPI Reference
Log In
API Reference

Retrieve all loans

get
https://api.ncinomortgage.com/loans

This endpoint will retrieve all loan records.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter loans by borrower name (prefix match against the borrower or co-borrower first or last name).

date

Filter to loans with a closing date on or before this date (inclusive).

date

Filter to loans with a closing date on or after this date (inclusive).

boolean

Filter loans by whether they are synced to the LOS.

boolean

Filter loans by active status (default true).

string

Filter loans by exact loan number.

uuid

Loan officer ID by which to filter loans.

string

Loan purpose search parameter by which to filter loans.

string

Loan type search parameter by which to filter loans.

string
enum

Sort by creation date: "asc" (oldest first, default) or "desc" (newest first).

Allowed:
uuid

Organization (company, region, or branch) ID by which to filter loans.

uuid

User borrower ID by which to filter loans.

integer

The page to retrieve.

integer

The number of records returned in each page.

date-time

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

date-time

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

date-time

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

date-time

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

Headers
string

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

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?