APG PayAPG Paydocs

Reporting

List report ranges

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

Return every named time range, in display order.

Permissions

Required permission
reports:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

columnsarray of RrngColumn

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

Responses

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

Discriminated by type
type = "RrngPageAttributes"
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": "RrngPageAttributes",
  "data": [
    {
      "type": "RrngAttributes",
      "reportRangeId": "string",
      "label": "string",
      "group": "Day",
      "range": {
        "type": "RqryRangeBetween",
        "from": "2026-08-19",
        "to": "2026-08-19"
      },
      "maxDays": 1250,
      "periodGrain": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses