DocumentationEmployees & Roles

Employees & Roles

4 minLast updated: 2026-03-31

Employee Model

Employees are people within your organization who access agents through the employee portal. Each employee belongs to a group and has one or more roles.

Roles & Agent Access

Roles define which agents an employee can use. When creating a role, specify the list of agent IDs that role grants access to:

POST /api/v1/groups/:groupId/roles
{
  "name": "Customer Service Rep",
  "agent_access": [
    "agent-uuid-1",
    "agent-uuid-2"
  ]
}

An employee can have multiple roles, their effective access is the union of all role permissions.

Jurisdiction

Jurisdiction controls which sub-groups an employee can access data from:

  • null: Own group only. Employee sees data only from their assigned group.
  • ["all"]: All descendants. Employee sees data from their group and every child group below it.
  • [12, 34]: Specific groups. Employee sees data only from the listed group IDs.

This enables scenarios like a regional manager seeing all branch data, while a branch employee sees only their branch.

Employee Portal Login

Employees log in to the portal at /portal/g/:slug. Authentication uses a portal-scoped JWT (type: portal, 8-hour expiry), completely separate from platform and customer auth.

Was this article helpful?