Scopes

The Scopes page shows the system's permission definitions — every individual permission that can be assigned to roles. This is an advanced administration page used to manage how permissions are organized in the navigation menu and role assignment interface.

📸

Screenshot: Scopes page showing a table with scope name, group, sort order, group order, agent restricted badge, and action buttons

scopes-list.png

1. Go to Organization → Scopes from the sidebar
2. Capture the table showing several scopes with their groups, sort orders, and agent restriction badges
Save to: static/img/screenshots/organization/scopes/scopes-list.png

Advanced feature

Most users don't need to manage scopes directly. Scopes are system-managed and primarily used to organize the permission structure. Use Roles & Permissions to assign permissions to roles instead.

---

Scopes table

Column	Description
#	Row number
Name	The scope identifier in resource:action format (e.g., leads:create, contacts:readAll)
Group	Which category this scope belongs to (e.g., Messaging, Customer Management)
Sort Order	Display order within the group
Group Order	Display order of the group in the menu
Agent Restricted	Yes (red badge) if agents cannot have this permission, No (green badge) if available to agents
Actions	View or Edit

Pagination

You can display 10, 25, or 50 scopes per page. Columns are sortable by name and sort order.

---

Scope details

Click View or Edit on a scope to see or modify its properties.

📸

Screenshot: Scope detail dialog showing all fields: name, sort order, group key, group title, group icon, group order, scope icon, parent scope, menu link, menu type, and toggles

scope-detail.png

1. Click Edit on a scope
2. Capture the dialog showing all scope configuration fields
Save to: static/img/screenshots/organization/scopes/scope-detail.png

Scope fields

Field	Description
Name	The scope identifier (e.g., leads:create). Format: resource:action.
Sort Order	Numeric order within the group — lower numbers appear first
Group Key	Internal group identifier (e.g., messaging, customers)
Group Title	Display name for the group (e.g., "Messaging", "Customer Management")
Group Icon	Icon displayed next to the group in the sidebar
Group Order	Numeric order for the group in the menu
Scope Icon	Icon for this specific scope
Parent Scope	Optional parent for hierarchical nesting (e.g., a sub-menu under a parent)
Menu Link	The navigation URL this scope links to (e.g., /leads/all, /dashboard)
Menu Type	Basic (single menu item), Collapsable (expandable group), or Group (section header)
Show in Navigation Menu	Whether this scope creates a visible item in the sidebar
Show in Role Assignment	Whether this scope appears in the permission selector
Restricted for Agents	If enabled, this scope is automatically removed from agent roles

---

Understanding scope names

Scopes follow the resource:action naming pattern:

Part	Examples	Description
Resource	leads, contacts, users, broadcast	The feature or data type
Action	create, read, readAll, update, delete	What the user can do

Special actions:

• readAll — View the list (table/grid) of all items
• read — View a single item's details
• * — All actions for the resource (full access)

Examples:

• leads:create — Can create new leads
• contacts:readAll — Can view the contacts list
• broadcast:send — Can send broadcast messages
• chatbot-flows:webhook — Can trigger chatbot flows via webhook

---

Tips

• Scopes are system-managed — avoid adding or removing scopes unless you understand the impact
• Use the Show in Role Assignment toggle to hide internal scopes from the role creation UI
• Use the Agent Restricted flag to prevent sensitive permissions from being assigned to agent roles
• The Group fields control how scopes are organized in the Roles & Permissions permission selector