APG PayAPG Paydocs

Reporting

Get report space

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

Return one space the caller can see.

Permissions

Required permission
reports:query

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

Path parameters

reportSpaceIdstring
required

Responses

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

Discriminated by type
type = "RspcViewAttributes"
reportSpaceIdRspcIdrequired

Identifier of a report space.

Example rspc_9f2Kd8QpLzXw

namestringrequired

Example Ada Lovelace

accessRspcAccessrequired
PrivateSharedSystemUnknown
parentReportSpaceIdRspcId

The space this one sits in, of the same tenant and access. Absent at the top.

Example rspc_9f2Kd8QpLzXw

ownedByCallerbooleanrequired

Whether the caller saved it.

Example true

editablebooleanrequired

Whether the caller may rename, move or delete it, and save or change what it holds.

Example true

isDefaultbooleanrequired

Whether it is its owner's default space, My reports until renamed: private, at the top, one per person per tenant. RspcCmdDefault finds it, and a private space deleted at the top hands what it held to it.

Example true

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

iconstring

The picture a client shows beside a System section's heading: acquiring, lending or platform. Absent for any other space.

Example
{
  "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"
}

Error responses