APG PayAPG Paydocs

Reporting

Get report pin

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

Return one of the caller's pins.

Permissions

Required permission
reports:query

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

Path parameters

reportPinIdstring
required

Responses

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

Discriminated by type
type = "RpinViewAttributes"
reportPinIdRpinIdrequired

Identifier of a pinned dashboard.

Example rpin_9f2Kd8QpLzXw

reportDashboardIdRdshIdrequired

Identifier of a saved dashboard.

Example rdsh_9f2Kd8QpLzXw

positioninteger (int32)required

Its place in the caller's list, from 0.

Example 1250

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "RpinViewAttributes",
  "reportPinId": "rpin_9f2Kd8QpLzXw",
  "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
  "position": 1250,
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses