APG PayAPG Paydocs

Reference data

List named lists

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

Return a page of the named lists the caller may see in one area, newest change first, optionally only one owner's.

Permissions

Required permission
rules:query

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

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.

columnsarray of NlstColumn

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

domainstring
required

The area whose lists are listed, as ruleAreaId names it.

ownerTypeRpolOwnerType

Only the lists this tenant owns, named with ownerId. Absent for every owner the caller may see.

PlatformEnterpriseMarketplaceMerchantUnknown
ownerIdstring

The id of the owner ownerType names. Absent for the platform.

Responses

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

Discriminated by type
type = "NlstPageAttributes"
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": "NlstPageAttributes",
  "data": [
    {
      "type": "NlstViewAttributes",
      "namedListId": "nlst_9f2Kd8QpLzXw",
      "name": "Ada Lovelace",
      "domain": "string",
      "owner": {
        "type": "RpolOwnerEnterprise",
        "enterpriseId": "ent_9f2Kd8QpLzXw"
      },
      "kind": "string",
      "description": "string",
      "version": 1250,
      "createdAt": "2026-08-19T04:21:07Z",
      "createdBy": "string",
      "updatedAt": "2026-08-19T04:21:07Z",
      "retiredAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses