List Roles
Retrieve all roles defined in your workspace.
GET
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
rolesarrayArray of role objects.
_idstringUnique identifier for the role.
namestringName of the role.
descriptionstringDescription of the role.
permissionsarrayArray of permission objects.
userIdsarrayArray 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"]
}
]