Skip to main content
GET
Get Loans

Path Parameters

organizationId
string
required

Query Parameters

portfolioId
string

The account to filter by

loanIds
string[]

The list of loan ids to filter by

loanSide
enum<string>

The loan side to filter by. See details

Available options:
lend,
borrow
loanType
enum<string>

The loan type to filter by. See details

Available options:
agency-lending-parent-loan,
agency-inventory,
agency-lending-collateralised-child-loan,
agency-title-transfer-collateralised-loan,
agency-lending-uncollateralised-child-loan,
agency-uncollateralised-loan,
agency-lending-first-lien-child-loan,
agency-clearloop-loan,
agency-lending-pledge-collateralised-child-loan,
agency-pledge-collateralised-loan,
bilateral-lending-title-transfer-collateralised-loan,
bilateral-title-transfer-collateralised-loan,
bilateral-lending-pledge-collateralised-loan,
bilateral-pledge-collateralised-loan,
bilateral-lending-uncollateralised-loan,
bilateral-uncollateralised-loan
loanTypes
enum<string>[]
Available options:
agency-lending-parent-loan,
agency-inventory,
agency-lending-collateralised-child-loan,
agency-title-transfer-collateralised-loan,
agency-lending-uncollateralised-child-loan,
agency-uncollateralised-loan,
agency-lending-first-lien-child-loan,
agency-clearloop-loan,
agency-lending-pledge-collateralised-child-loan,
agency-pledge-collateralised-loan,
bilateral-lending-title-transfer-collateralised-loan,
bilateral-title-transfer-collateralised-loan,
bilateral-lending-pledge-collateralised-loan,
bilateral-pledge-collateralised-loan,
bilateral-lending-uncollateralised-loan,
bilateral-uncollateralised-loan
statuses
enum<string>[]

The loan status to filter by. See details

Available options:
awaiting-approval,
awaiting-acceptance,
awaiting-collateral,
awaiting-interest-payment,
disbursing,
active,
repaying,
defaulting,
partially-defaulting,
early-termination-in-progress,
early-termination-completed,
defaulted,
default-resolved,
cancelled,
rejected,
errored,
repaid,
repaying-interest,
interest-repaid,
securing-collateral,
collateral-secured,
releasing-collateral,
collateral-released,
closed
isOpen
boolean
default:false

Flag to filter out open loans

includeCollaterals
boolean
default:false

Flag indicating if collaterals should be included in embedded

includeCounterparties
boolean
default:false

Flag indicating if counterparties should be included in embedded

includeChildLoans
boolean
default:false

Flag indicating if child loans should be included in embedded - Only applicable for agency lending parent loans

includeLoanAllocations
boolean
default:false

Flag indicating if allocations should be included in embedded

includeLoanInterest
boolean
default:false

Flag indicating if loan interest should be included in embedded - Only applicable for bilateral loans

limit
string

The number of loans to include in the response

offset
string

The number of loans to skip in the response

sortBy
string
default:LoanStatus by relevance

The field to sort by. Currently supported: updatedAt

sortDirection
enum<string>
default:desc

The direction to sort by - must be used in conjunction with sortBy. See details

Available options:
ASC,
DESC

Response

OK

loans
object[]
required

The list of loans