APG PayAPG Paydocs

Identity

Get role

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

Return one role, with its grants resolved.

Permissions

Required permission
roles:query

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

Path parameters

roleIdstring
required

Responses

The response is a typed union.

Discriminated by type
type = "RoleViewBuiltIn"
roleIdRoleIdrequired

Identifier of a role.

Example role_9f2Kd8QpLzXw

namestringrequired

Example Ada Lovelace

The grants this role carries.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "RoleViewBuiltIn",
  "roleId": "role_9f2Kd8QpLzXw",
  "name": "Ada Lovelace",
  "grants": [
    {
      "type": "RoleGrantAttributes",
      "resource": "BlockedCard",
      "actions": [
        "Create"
      ]
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses