APG PayAPG Paydocs

Ledgers and journals

List journals

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

Return a page of journals. A journal is identified by five things together, so the filters narrow rather than name one.

Permissions

Required permission
systemJournals:query

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

Query parameters

qstring

Search. Matches a journal id, the id of its ledger, the owner's name or the owner identifier. 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 SjnlSort

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

columnsarray of SjnlColumn

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

ownerTypeSjnlOwnerType

Filter by what kind of party owns the journal.

MerchantLoanUnknown
ownerIdentifierone of array of string, string

Which owner of that kind. Repeat the parameter to supply several.

categoryone of JnalCategory, array of JnalCategory

Which of that owner's journals. Repeat the parameter to supply several.

linkedToLedgerboolean

Whether the journal has been linked to the ledger it clears into.

Responses

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

Discriminated by type
type = "SjnlPageAttributes"
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": "SjnlPageAttributes",
  "data": [
    {
      "type": "SjnlViewAttributes",
      "journalId": "sjnl_9f2Kd8QpLzXw",
      "businessKey": {
        "type": "SjnlBusinessKeyAttributes",
        "ownerType": "Merchant",
        "ownerIdentifier": "string",
        "category": "General",
        "clearanceSystem": "string",
        "currency": "AUD"
      },
      "systemLedgerId": "sldg_9f2Kd8QpLzXw",
      "clearanceTimeZone": "string",
      "lastClearanceDate": "2026-08-19",
      "lastClearanceAt": "2026-08-19T04:21:07Z",
      "ownerName": "Ada Lovelace",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses