GET
/
organizations
/
{organizationId}
/
loans
curl --request GET \
  --url https://api.copper.co/platform/organizations/{organizationId}/loans
{
  "loans": [
    {
      "amount": "<string>",
      "borrowerCounterpartyId": "<string>",
      "borrowerOrganizationId": "<string>",
      "borrowerPortfolioId": "<string>",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "currency": "<string>",
      "debtRatio": "<string>",
      "debtRatioUpdatedAt": "<string>",
      "defaultReason": "<string>",
      "embedded": {
        "childLoans": [
          {}
        ],
        "collaterals": [
          {
            "amount": "<string>",
            "collateralId": "<string>",
            "createdAt": "<string>",
            "currency": "<string>",
            "loanId": "<string>",
            "mainCurrency": "<string>",
            "portfolioId": "<string>",
            "unrealisedAmount": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "counterparties": [
          {
            "backgroundImageId": "<string>",
            "counterpartyDescription": "<string>",
            "counterpartyId": "<string>",
            "counterpartyName": "<string>",
            "counterpartyType": "standard",
            "extra": {
              "exchangeId": "<string>"
            },
            "imageId": "<string>",
            "networkTag": "<string>",
            "priority": "<string>",
            "tags": [
              "featured"
            ]
          }
        ],
        "loanAllocations": [
          {
            "allocationType": "disburse",
            "amount": "<string>",
            "counterpartyOrderId": "<string>",
            "createdAt": "<string>",
            "createdBy": "<string>",
            "currency": "<string>",
            "externalFailureDescription": "<string>",
            "extra": {
              "acceptedAt": "<string>",
              "acceptedBy": "<string>",
              "cancelledAt": "<string>",
              "cancelledBy": "<string>",
              "confirmedAt": "<string>",
              "confirmedBy": "<string>",
              "effectiveDate": "<string>"
            },
            "fromPortfolioId": "<string>",
            "loanAllocationId": "<string>",
            "loanId": "<string>",
            "mainCurrency": "<string>",
            "orderId": "<string>",
            "requestorCounterpartyId": "<string>",
            "status": "new",
            "terminatedAt": "<string>",
            "toPortfolioId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "loanInterest": {
          "accruedInterest": "<string>",
          "createdAt": "<string>",
          "interestCurrency": "<string>",
          "lastPaymentAt": "<string>",
          "loanId": "<string>",
          "loanInterestId": "<string>",
          "realisedInterest": "<string>",
          "unrealisedInterest": "<string>",
          "updatedAt": "<string>"
        },
        "loanModifications": [
          {
            "createdAt": "<string>",
            "createdBy": "<string>",
            "extra": {
              "acceptedAt": "<string>",
              "acceptedBy": "<string>",
              "cancelledAt": "<string>",
              "cancelledBy": "<string>",
              "currentInterestRate": "<string>",
              "currentMaturityDate": "<string>",
              "newInterestRate": "<string>",
              "newMaturityDate": "<string>"
            },
            "loanId": "<string>",
            "loanModificationId": "<string>",
            "modificationType": "rerate",
            "requestorCounterpartyId": "<string>",
            "status": "awaiting-acceptance",
            "updatedAt": "<string>"
          }
        ]
      },
      "externalId": "<string>",
      "extra": {
        "acceptedAt": "<string>",
        "acceptedBy": "<string>",
        "approvedAt": "<string>",
        "approvedBy": "<string>",
        "cancelledAt": "<string>",
        "cancelledBy": "<string>",
        "defaultThreshold": "<string>",
        "defaultedAt": "<string>",
        "defaultedBy": "<string>",
        "disbursedAt": "<string>",
        "externalDisbursal": true,
        "externalInterestPayment": true,
        "initialLtv": "<string>",
        "initiallyRequiredCollateralUsd": "<string>",
        "lenderFeeShare": "<string>",
        "lenderFeeSharePercentage": "<string>",
        "marginCallThreshold": "<string>",
        "rebalanceThreshold": "<string>",
        "rejectedAt": "<string>",
        "rejectedBy": "<string>",
        "repaidAt": "<string>",
        "repaidBy": "<string>",
        "requiredCollaterals": [
          {
            "amount": "<string>",
            "amountInUsd": "<string>",
            "currency": "<string>",
            "mainCurrency": "<string>"
          }
        ]
      },
      "interestRate": "<string>",
      "lenderCounterpartyId": "<string>",
      "lenderOrganizationId": "<string>",
      "lenderPortfolioId": "<string>",
      "loanId": "<string>",
      "loanType": "agency-lending-parent-loan",
      "mainCurrency": "<string>",
      "maturityDate": "<string>",
      "startDate": "<string>",
      "status": "awaiting-approval",
      "terminatedAt": "<string>",
      "unrealisedAmount": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

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-lending-collateralised-child-loan,
agency-lending-uncollateralised-child-loan,
agency-lending-first-lien-child-loan,
bilateral-lending-title-transfer-collateralised-loan
​
loanTypes
enum<string>[]

See details

​
statuses
enum<string>[]

The loan status to filter by. See details

​
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>

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

Available options:
ASC,
DESC

Response

200
application/json

OK

The response is of type object.