APG PayAPG Paydocs

Parties

List organisations

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

Return a page of the organisations 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
organisations:query

Requires the `query` action on `organisations` 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 OrgSort

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

columnsarray of OrgColumn

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 organisations linked to this merchant: its own, its customers' and the owners reached from either.

customerIdstring

Only the organisation a customer is, and the organisations that own it.

nameContainsstring

Only organisations whose registered name contains this text.

Responses

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

Discriminated by type
type = "OrgPageAttributes"
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": "OrgPageAttributes",
  "data": [
    {
      "type": "OrgViewAttributes",
      "organisationId": "org_9f2Kd8QpLzXw",
      "registeredName": "Ada Lovelace",
      "businessType": "Company",
      "companyType": "string",
      "taxIdentity": {
        "type": "OrgTaxIdentityAttributes",
        "businessRegistrationNumber": "string",
        "companyRegistrationNumber": "string",
        "taxRegistrationNumber": "string"
      },
      "country": "AU",
      "registeredAddress": {
        "type": "MchtAddressAttributes",
        "unitNumber": "string",
        "streetNumber": "string",
        "streetName": "Ada Lovelace",
        "streetType": "string",
        "suburb": "string",
        "city": "string",
        "state": "string",
        "postalCode": "3000",
        "country": "AU"
      },
      "contactDetails": {
        "type": "OrgContactDetailsAttributes",
        "emailAddress": "ada@example.com",
        "phoneNumber": "+61400000000",
        "address": {
          "type": "MchtAddressAttributes",
          "unitNumber": "string",
          "streetNumber": "string",
          "streetName": "Ada Lovelace",
          "streetType": "string",
          "suburb": "string",
          "city": "string",
          "state": "string",
          "postalCode": "3000",
          "country": "AU"
        }
      },
      "owners": [
        {
          "type": "OrgOwnerOrganisation",
          "organisationId": "org_9f2Kd8QpLzXw"
        }
      ],
      "documents": [
        {
          "type": "OrgDocumentAttributes",
          "kind": "TrustDeed",
          "fileId": "lfile_9f2Kd8QpLzXw"
        }
      ],
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses