List Available Permissions
Retrieve all available permissions that can be assigned to roles.
GET
Requires the role:view permission in the workspace.
Returns a single object keyed by category. Each category maps an action name to its permission key. The keys (the values, in category:action form) are what you send in permissions when you create or update a role.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Response
{category}objectOne entry per category, for example agent, pathway (call flows), message_pathway (message flows), knowledge_base or call_history. Each maps an action (e.g., view) to the permission key (e.g., agent:view).
The current categories and keys are:
| Category | Permission keys |
|---|---|
workspace | workspace:create, workspace:view, workspace:edit, workspace:delete |
agent | agent:create, agent:view, agent:edit, agent:delete |
phone_number | phone_number:create, phone_number:view, phone_number:edit, phone_number:delete |
pathway | pathway:create, pathway:view, pathway:edit, pathway:delete |
message_pathway | message_pathway:create, message_pathway:view, message_pathway:edit, message_pathway:delete |
knowledge_base | knowledge_base:create, knowledge_base:view, knowledge_base:edit, knowledge_base:delete |
team | team:view, team:add_member, team:remove_member, team:edit |
billing | billing:view, billing:edit, billing:purchase |
api_keys | api_keys:view, api_keys:create, api_keys:delete |
role | role:create, role:view, role:edit, role:delete |
agency_hub | agency_hub:view, agency_hub:edit, agency_hub:manage_plans, agency_hub:manage_clients (agency master workspaces only) |
workflow | workflow:create, workflow:view, workflow:edit, workflow:delete |
call_history | call_history:view |
call_flags | call_flags:view, call_flags:manage |
ai_assistant | ai_assistant:use |
Read the list from this endpoint rather than hard-coding it. New permissions are added as features ship.
{
"workspace": {
"create": "workspace:create",
"view": "workspace:view",
"edit": "workspace:edit",
"delete": "workspace:delete"
},
"agent": {
"create": "agent:create",
"view": "agent:view",
"edit": "agent:edit",
"delete": "agent:delete"
},
"team": {
"view": "team:view",
"add_member": "team:add_member",
"remove_member": "team:remove_member",
"edit": "team:edit"
},
"call_history": {
"view": "call_history:view"
},
"call_flags": {
"view": "call_flags:view",
"manage": "call_flags:manage"
},
"ai_assistant": {
"use": "ai_assistant:use"
}
}Last updated on