COcopper-co
lending

Get Loans

Retrieve loans

get/organizations/{organizationId}/loans

Request

Path parameters

organizationIdstring required

Query parameters

portfolioIdstring

The account to filter by

loanIdsstring[]

The list of loan ids to filter by

loanSide'lend' | 'borrow'

The loan side to filter by. See details

loanType'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'

The loan type to filter by. See details

loanTypesLoanType[]

See details

statusesLoanStatus[]

The loan status to filter by. See details

isOpenboolean

Flag to filter out open loans

includeCollateralsboolean

Flag indicating if collaterals should be included in embedded

includeCounterpartiesboolean

Flag indicating if counterparties should be included in embedded

includeChildLoansboolean

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

includeLoanAllocationsboolean

Flag indicating if allocations should be included in embedded

includeLoanInterestboolean

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

limitstring

The number of loans to include in the response

offsetstring

The number of loans to skip in the response

sortBystring

The field to sort by. Currently supported: updatedAt

sortDirection'ASC' | 'DESC'

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

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.