APG PayAPG Paydocs

Reference data

List named list entries

GET/named-lists/{namedListId}/entries
Request
GEThttps://api.tst.au.apgpay.dev/named-lists/{namedListId}/entries
curl -X GET https://api.tst.au.apgpay.dev/named-lists/{namedListId}/entries \
  -H "Authorization: Bearer $API_KEY"

Return the entries a list held at a version, the current one where none is named, in the order of their values. A version the list never had is a 404.

Permissions

Required permission
rules:query

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

Path parameters

namedListIdstring
required

Query parameters

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.

versioninteger (int32)

The version of the list whose entries are read. The current version where absent.

Responses

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

Discriminated by type
type = "NlstEntryPageAttributes"
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": "NlstEntryPageAttributes",
  "data": [
    {
      "type": "NlstEntryAttributes",
      "value": "string",
      "addedIn": 1250,
      "removedIn": 1250,
      "addedAt": "2026-08-19T04:21:07Z",
      "addedBy": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses