Browse the API30

portfolio

get

/api/v1/portfolio/loans

The organization's funded loans, filtered, sorted and paginated.

Scope: portfolio:read
Rate limit: 200 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope portfolio:read; a key without it receives 403 forbidden.

Query parameters

orderstring (enum)ascdesc

pageintegerdefault 1min 1

per_pageintegerdefault 25min 1max 100

searchstring

sortstring (enum)balancenext_duerateoriginated

statusstring (enum)activedelinquentdefaultedpaid_offpending_disbursementcancelled

Request body

This operation takes no request body.

Response

200application/json

dataSerializedLoan[]required

paginationobjectrequired

pagenumberrequired

per_pagenumberrequired

totalnumberrequired

total_pagesnumberrequired

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/portfolio/loans?page=1&per_page=25" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "data": [
    {
      "id": string,
      "case_id": string | null,
      "borrower": string,
      "borrower_type": string,
      "product": string,
      "status": string,
      "principal_amount": number,
      "remaining_balance": number,
      "total_repaid": number,
      "monthly_payment": number,
      "interest_rate": number,
      "term_months": number,
      "origination_date": string | null,
      "maturity_date": string | null,
      "next_payment_date": string | null,
      "days_late": number,
      "payments_made": number,
      "payments_remaining": number
    }
  ],
  "pagination": {
    "page": number,
    "per_page": number,
    "total": number,
    "total_pages": number
  }
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.