APG PayAPG Paydocs

Reference data

Get named list

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

Return one named list as its current version holds it, without its entries.

Permissions

Required permission
rules:query

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

Path parameters

namedListIdstring
required

Responses

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

Discriminated by type
type = "NlstViewAttributes"
namedListIdNlstIdrequired

Identifier of a named list.

Example nlst_9f2Kd8QpLzXw

namestringrequired

The list's name, which is unique among its owner's lists of the same area.

Example Ada Lovelace

domainstringrequired

The area the list is for, as ruleAreaId names it.

kindstringrequired

The kind of entry it holds, one of its area's listKinds. Each entry is checked to be a member of the kind.

descriptionstring
versioninteger (int32)required

The current version, which an edit names as expectedVersion.

Example 1250

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

createdBystringrequired
updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

retiredAtstring (date-time)

When the list was retired. Absent for one that is not.

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses