APG PayAPG Paydocs

Loans

List loan agreements

GET/loan-agreements
Request
GEThttps://api.tst.au.apgpay.dev/loan-agreements
curl -X GET https://api.tst.au.apgpay.dev/loan-agreements \
  -H "Authorization: Bearer $API_KEY"

Return a page of loan agreements. Supply page for offset pagination or startingAfter for cursor pagination, and q to search. GET /filter-catalogues/loan-agreements lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400.

Permissions

Required permission
loanMasterAgreements:query

Requires the `query` action on `loanMasterAgreements` for the supplied runtime context

Query parameters

qstring

Search. Matches a loan agreement id, the id of its facility, the reference agreement id or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

sortarray of LmaSort

Fields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.

columnsarray of LmaColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

loanFacilityIdone of array of string, string

Only loan agreements whose facility is one of these. Repeat the parameter to give several.

loanFacilityIdNotone of array of string, string

Leave out loan agreements whose facility is one of these. Repeat the parameter to give several.

referenceAgreementIdstring

Find an agreement by the applicant's own reference.

currencyone of IsoCurrency, array of IsoCurrency

Only loan agreements whose currency is one of these. Repeat the parameter to give several.

currencyNotone of IsoCurrency, array of IsoCurrency

Leave out loan agreements whose currency is one of these. Repeat the parameter to give several.

Responses

The response is a tagged shape: type is always "LmaPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "LmaPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "LmaPageAttributes",
  "data": [
    {
      "type": "LmaViewAttributes",
      "loanAgreementId": "lma_9f2Kd8QpLzXw",
      "loanFacilityId": "lfac_9f2Kd8QpLzXw",
      "enterpriseId": "ent_9f2Kd8QpLzXw",
      "referenceAgreementId": "your-own-reference",
      "description": "string",
      "balances": {
        "type": "LmaBalancesAttributes",
        "currency": "AUD",
        "available": 1250,
        "used": 1250,
        "maxLimit": 500000
      },
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses