Trillet AI logo

List Roles

Retrieve all roles defined in your workspace.

GEThttps://api.trillet.ai/v1/api/roles-and-permissions/roles

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Response Fields

rolesarray

Array of role objects.

_idstring

Unique identifier for the role.

namestring

Name of the role.

descriptionstring

Description of the role.

permissionsarray

Array of permission objects.

userIdsarray

Array of user IDs assigned to this role.

[
  {
    "_id": "665a1b2c3d4e5f6a7b8c9d0e",
    "name": "Admin",
    "description": "Full access to all workspace features",
    "permissions": [
      { "key": "agent_view", "category": "agents" },
      { "key": "agent_create", "category": "agents" }
    ],
    "userIds": ["user_001", "user_002"]
  },
  {
    "_id": "665a1b2c3d4e5f6a7b8c9d0f",
    "name": "Viewer",
    "description": "Read-only access",
    "permissions": [
      { "key": "agent_view", "category": "agents" },
      { "key": "call_history_view", "category": "calls" }
    ],
    "userIds": ["user_003"]
  }
]