List the permission catalogue

GET /api/v1/permissions prm_roles_manage

Every permission code this build defines, with its group, label, help text, stated effect and risk class. This is the authoritative list a role editor or a token scope picker should render from.

English only, and deliberately not translated — these are operator-facing catalogue strings baked into the build, not localized messages. risk is read, write or danger, and is the right signal for warning someone before they tick a box.

At a glance

Authentication: Staff token or session
Requires permission: prm_roles_manage Manage roles & permissions

Request

curl -X GET "$BASE/api/v1/permissions" \
  -H "Authorization: Bearer $XR_TOKEN"

Response 200 OK

{
  "data": [
    {
      "code": "prm_users_index",
      "group": "Subscribers",
      "label": "View subscribers",
      "desc": "See the subscriber list and open a subscriber record.",
      "effect": "Read-only.",
      "risk": "read"
    }
  ]
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us