APG PayAPG Paydocs

Reporting

List report spaces

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

Return a page of the spaces the caller can see, in the order they were saved. q matches part of a name. Walk the pages by passing nextStartingAfter back as startingAfter; page and endingBefore are refused with 400.

Permissions

Required permission
reports:query

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

Query parameters

qstring

Free-text search. Supplying it engages the search index; omit it to filter only.

startingAfterstring

Cursor pagination, forward only: the nextStartingAfter of the page before.

limitinteger (int32)

Maximum items per page.

columnsarray of RspcColumn

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

reportSpaceIdstring

Only the spaces sitting directly in this one.

ownerstring

me for what the caller saved.

tenantstring

Only the spaces of this enterprise, marketplace or merchant id. The caller's own tenant lists the spaces it sees there; a tenant beneath it lists the spaces that tenant shares, read only, for a caller with ReportsOversight_Query.

Responses

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

Discriminated by type
type = "RspcPageAttributes"
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": "RspcPageAttributes",
  "data": [
    {
      "type": "RspcViewAttributes",
      "reportSpaceId": "rspc_9f2Kd8QpLzXw",
      "name": "Ada Lovelace",
      "access": "Private",
      "parentReportSpaceId": "rspc_9f2Kd8QpLzXw",
      "tenant": {
        "type": "RspcTenantEnterprise",
        "enterpriseId": "ent_9f2Kd8QpLzXw"
      },
      "ownedByCaller": true,
      "editable": true,
      "isDefault": true,
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z",
      "icon": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses