APG PayAPG Paydocs

Parties

List persons

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

Return a page of the persons in the caller's scope, newest first unless sort says otherwise. Supply page for offset pagination or startingAfter for cursor pagination. A cursor continues only the walk that issued it: sent with different filters or sort, it is refused with 400.

Permissions

Required permission
persons:query

Requires the `query` action on `persons` 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.

sortarray of PrsnSort

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

columnsarray of PrsnColumn

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

merchantIdstring

Only the persons linked to this merchant: its own persons, its customers' and the owners reached from either.

customerIdstring

Only the person a customer is, and the persons who own the organisation a customer is.

nameContainsstring

Only persons whose name contains this text.

Responses

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

Discriminated by type
type = "PrsnPageAttributes"
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": "PrsnPageAttributes",
  "data": [
    {
      "type": "PrsnViewAttributes",
      "personId": "pson_9f2Kd8QpLzXw",
      "givenName": "Ada Lovelace",
      "middleName": "Ada Lovelace",
      "familyName": "Ada Lovelace",
      "dateOfBirth": "2026-08-19",
      "identityDocuments": [
        {
          "type": "PsonDocumentDriverLicence",
          "number": "string",
          "issuingCountry": "AU",
          "issuingRegion": "string",
          "documentNumber": "string",
          "versionNumber": "string"
        }
      ],
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses