Get Available Loan Types

get

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

Retrieve available loan types for representation in your application. Optionally pass the loanGroup query parameter (a loan group UUID) to return only the loan types associated with that loan group, ordered by their configured priority. Permission: Read Loan Types

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

loanGroup

uuid

Optional loan group UUID. When provided, only loan types associated with this loan group are returned, ordered by their configured priority. Use the uuid from GET /api/loan-groups.

Responses

200Successful response

401401

500500