latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

API Keys

List the Permission Catalog

Lists the catalog of permission actions that can be granted to users, apps, and API keys — the source for the dashboard's permission pickers. Small and returned in full on one page.

get/api_keys/permissions

Response

permission catalog listed

Example response

{
  "data": [
    {
      "action": "access_pass:basic:export",
      "allowed_on_api_key": true,
      "allowed_on_app": true,
      "category": "Products",
      "description": "Download the account's product list as a CSV.",
      "granted_to_system_roles": [
        "owner"
      ],
      "name": "Export products"
    }
  ]
}