Get Loans

get

https://{your-totality-url}.com/api/loans

Retrieve paginated list of loans. Permission: Read Loans

Recipes

📱

Get most recent active loan with tags from Mobile Phone

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Page

string

Defaults to page=5

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

Sort

string

Defaults to sort=+createdAt

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

Filter

string

Defaults to createdAt=eq:2022-01-01

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

approvedAt

string

When the loan was approved. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

autoSchedulePaymentAmount

integer

The auto-schedule payment amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

becameEligibleForRefinanceOn

string

When the loan became eligible for refinancing. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

createdAt

string

When the loan application was submitted. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

creditServiceOrganizationId

integer

The database ID of the associated CSO. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

customerEmail

string

The email address of the customer who owns the loan. Sortable: No. Filter Operators: eq, in, nin, ne, neq, nn, null

customerId

integer

The internal database ID of the customer. Sortable: No. Filter Operators: eq, ne, neq, nn, null

customerName

string

The full name of the customer who owns the loan. Sortable: No. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

customerUuid

string

The UUID of the customer who owns the loan. Use to filter all loans for a specific customer. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

daysLate

integer

The number of days the loan is past due. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

decisioningProvider

string

The third-party decisioning provider used to underwrite the loan. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

deferredPayments

integer

The number of deferred (skipped) payments. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

denialReason

string

The reason the loan was denied. Possible values include: Approved by another lender, Bad bank, Currently unemployed, Customer did not apply, Duplicate Application, Not enough income, Open bankruptcy, Risk of fraud, Self-employed, Unemployed, Other, and more. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

deniedAt

string

When the loan was denied. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

desiredPrincipalAmount

integer

The principal amount originally requested by the borrower, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

estimatedFundingOn

string

The estimated funding date. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

externalId

string

An external identifier from a third-party system. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

firstPaymentDate

string

The date the first payment is due. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

funded

integer

The actual dollar amount funded to the borrower. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

fundedAt

string

When the loan was funded. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

hasHardPrincipalPayments

boolean

Whether the loan has fixed principal payment amounts. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

integer

The internal database ID of the loan. Sortable: No. Filter Operators: eq, ne, neq, nn, null

interestCalculatedFrequency

string

How frequently interest is calculated on the loan. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

interestRate

number

The interest rate (e.g., 36.5 represents 36.5%). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

isAutoScheduled

boolean

Whether payments are automatically scheduled. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isContractViewable

boolean

Whether the loan contract is available for viewing. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isFirstPaymentDefaulted

boolean

Whether the borrower defaulted on the first payment. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isInterestAndFeesOnlyDue

boolean

Whether only interest and fees are due (no principal reduction). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isInterestAppliedAfterContract

boolean

Whether interest begins accruing after contract signing. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

lastPaymentDate

string

The date of the most recent payment. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

lateFeeAmount

integer

The fixed late fee amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

lateFeeMax

integer

The maximum late fee amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

lateFeePercentage

integer

The late fee percentage (e.g., 5.0 represents 5%). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

leadExternalId

string

The external identifier of the originating lead. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

leadProvider

string

The lead provider or referral source. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

leadType

string

The type classification of the originating lead. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

loanGroupUuid

string

The UUID of the loan group. Use the GET /api/loan-groups endpoint to find available values. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

loanOriginationType

string

How the loan originated. Possible values: New, Refinanced, Reloaned. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

loanTypeUuid

string

The UUID of the loan type. Use the GET /api/loan-types endpoint to find available values. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

nextAutoScheduleDate

string

The next auto-schedule date. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

numberOfPayments

integer

The total number of scheduled payments. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

originalApr

number

The original APR (e.g., 36.5 represents 36.5%). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

originalLoanUuid

string

The UUID of the original loan if this is a refinance. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

originalPrincipleAmount

integer

The original principal amount of the loan in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

outstandingFee

integer

The outstanding fee balance in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

outstandingInterest

integer

The outstanding interest balance in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

outstandingPrincipal

integer

The outstanding principal balance in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

paidOffAt

string

When the loan was fully paid off. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

paymentFrequency

string

How often payments are due. Possible values: days, weekly, bi-weekly, semi-monthly, monthly. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

refinanceAmount

integer

The amount rolled over from the original loan, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

reversedAt

string

When the loan was reversed. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

saleType

string

The sale type. Possible values: Sale, Placement. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

settledAt

string

When the loan was settled. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

signedAt

string

When the contract was signed. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

soldAt

string

When the loan was sold. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

soldTo

string

The entity the loan was sold to. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

status

string

The current loan status. Possible values: Approved, Denied, Funded, Paid In Full, Pending, Pending Paid In Full, Rescinded, Reversed, Sold, Withdrawn, Withdrawn (Expired), Written Off. Sortable: Yes. Filter Operators: eq, se, in, nin, ne, neq, nn, null

200Successful response

401401

403403

500500