APG PayAPG Paydocs

Identity

List users

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

Return a page of users. Supply page for offset pagination or startingAfter for cursor pagination, and q to search. GET /filter-catalogues/users lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400.

Permissions

Required permission
users:query

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

Query parameters

qstring

Search. Matches a user id, the display name, or the whole email address or phone number the user signs in with. 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 UserSort

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

columnsarray of UserColumn

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

userIdone of array of string, string

Only users whose id is one of these. Repeat the parameter to give several.

statusone of UserStatus, array of UserStatus

Only users whose status is one of these. Repeat the parameter to give several.

enterpriseIdone of array of string, string

Only users whose enterprise is one of these. Repeat the parameter to give several.

marketplaceIdone of array of string, string

Only users whose marketplace is one of these. Repeat the parameter to give several.

merchantIdone of array of string, string

Only users whose merchant is one of these. Repeat the parameter to give several.

customerIdone of array of string, string

Only users whose customer is one of these. Repeat the parameter to give several.

delegateIdone of array of string, string

Only users whose delegate is one of these. Repeat the parameter to give several.

emailAddressone of array of string, string

Only users whose email address is one of these. Repeat the parameter to give several.

phoneNumberone of array of string, string

Only users whose phone number is one of these. Repeat the parameter to give several.

Responses

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

Discriminated by type
type = "UserPageAttributes"
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": "UserPageAttributes",
  "data": [
    {
      "type": "UserViewAttributes",
      "userId": "user_9f2Kd8QpLzXw",
      "displayName": "Ada Lovelace",
      "identifiedBy": [
        {
          "type": "UserIdEmail",
          "emailAddress": "ada@example.com"
        }
      ],
      "authorisedTo": [
        {
          "type": "UserPermissionAttributes",
          "domain": {
            "type": "UserDomainAnonymous",
            "restrictedTo": {
              "type": "UserDomainCustomer",
              "customerId": "cust_9f2Kd8QpLzXw"
            }
          },
          "roles": [
            "role_9f2Kd8QpLzXw"
          ]
        }
      ],
      "status": "Enabled",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses