Get a list of all RBAC permissions grouped by resource type Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

Close
GET /api/v1/static/rbac-permissions

Returns the permission catalogue for the authenticated account's firm. groups maps each group slug to its display label, resources maps each resource type slug to its display label, and permissions lists the assignable permissions under each group. Permissions belonging to features the firm does not have enabled are omitted.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • groups object
        Hide groups attributes Show groups attributes object
        • accounts string
        • external string
        • plans string
      • resources object
        Hide resources attributes Show resources attributes object
        • external string
        • plans string
        • tasks string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • accounts array[object]
          Hide accounts attributes Show accounts attributes object
          • label string
          • value string
        • external array[object]
          Hide external attributes Show external attributes object
          • label string
          • value string
        • plans array[object]
          Hide plans attributes Show plans attributes object
          • label string
          • value string
GET /api/v1/static/rbac-permissions
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/static/rbac-permissions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": {
    "groups": {
      "accounts": "Accounts",
      "external": "External",
      "plans": "Plans"
    },
    "resources": {
      "external": "Introducers",
      "plans": "Plans",
      "tasks": "Tasks"
    },
    "permissions": {
      "accounts": [
        {
          "label": "View Tasks",
          "value": "tasks:read"
        },
        {
          "label": "Update Tasks",
          "value": "tasks:update"
        }
      ],
      "external": [
        {
          "label": "View Introducers",
          "value": "external:read"
        }
      ],
      "plans": [
        {
          "label": "View Plans",
          "value": "plans:read"
        },
        {
          "label": "View All Plans",
          "value": "plans:readAll"
        }
      ]
    }
  }
}