Permission Sets

The Permission Set object represents a set of permissions that can be assigned to a user.

You can find out more about permission sets in our Help documentation: Permission Sets

Attributes

active_agents_count integer
Response Parameter `filter` Parameter `sort`

The number of active AI agents currently assigned to this role.
active_users_count integer
Response Parameter `filter` Parameter `sort`

The number of active users currently assigned to this role.
base_role_id integer
Response Request Parameter `filter` Enum

ID of the base role type this custom role is derived from (determines the permission baseline).

Enum Values (14 values)

  • 1
    Admin
  • 2
    Profitability Manager
  • 3
    Staff
  • 4
    Client Manager
  • 5
    Client Staff
  • 6
    Contractor
  • 7
    Staff with CRM access
  • 8
    Staff with time access
  • 9
    Staff with CRM and time access
  • 10
    Profitability Manager with restricted access
  • 11
    Coordinator
  • 12
    Manager
  • 13
    Manager with restricted access
  • 14
    Coordinator with restricted access
description string
Response Request

[DESCRIPTION]
editable_by_user boolean
Response

Whether this role can be modified by regular users, or is a system-managed role.
id integer
Parameter `filter`

The unique identifier of this role.
inactive_agents_count integer
Response Parameter `filter` Parameter `sort`

The number of inactive AI agents assigned to this role.
inactive_users_count integer
Response Parameter `filter` Parameter `sort`

The number of inactive users assigned to this role.
name string
Response Request Parameter `filter` Parameter `sort`

The display name of this role.
organization organization
Response

The organization this role belongs to.
people_count integer
Response

The number of people currently assigned to this role.
permissions object
Response Request Parameter `filter`

The explicit permission settings configured for this role.
resolved_permissions object
Response

The effective resolved permissions for this role, including inherited permissions from the base role.
user_type_id integer
Response Request Parameter `filter` Enum

ID of the user type associated with this role (e.g. full user, limited user).

Enum Values (2 values)

  • 1
    Time tracker
  • 2
    Client

Operations

GET /api/v2/roles
Get permission sets
POST /api/v2/roles
Create a permission set
DELETE /api/v2/roles/{id}
Delete a permission set
GET /api/v2/roles/{id}
Get a permission set
PATCH /api/v2/roles/{id}
Update a permission set