Skip to content
vocapable.Docs

Built-in and custom roles, and what each can do

GET
/v1/workspace/roles
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/roles \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceRoles
object
builtin
required
Builtin
Array<object>
WorkspaceBuiltinRole
object
key
required
Key
string
Allowed values: owner manager rep
name
required
Name
string
capabilities
required
Capabilities
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
permissions
Permissions
Array<string>
custom
required
Custom
Array<object>
WorkspaceCustomRole
object
id
required
Id
string
name
required
Name
string
description
required
Any of:
string
capabilities
required
Capabilities
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
scope
required
Scope
string
Allowed values: company teams
holder_count
required
Holder Count
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
permissions
Permissions
Array<string>
grantable
required
Grantable
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
team_scopable
required
Team Scopable
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
permission_catalog
Permission Catalog
Array<object>
WorkspacePermissionInfo

One permission of the CC7-R2 catalog, for the Roles matrix.

object
key
required
Key
string
group
required
Group
string
label
required
Label
string
description
required
Description
string
capability
required
Capability
string
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
base
required
Base
boolean
requires
required
Requires
Array<string>
grantable
required
Grantable
boolean
team_scopable
required
Team Scopable
boolean
templates
Templates
Array<object>
WorkspaceRoleTemplate

A starting point (supervisor, team lead, WFM analyst, QA evaluator, read-only analyst): create a custom role from it, then edit it.

object
key
required
Key
string
name
required
Name
string
description
required
Description
string
scope
required
Scope
string
Allowed values: company teams
permissions
required
Permissions
Array<string>
Example
{
  "builtin": [
    {
      "key": "owner",
      "capabilities": [
        "view_all_customers"
      ]
    }
  ],
  "custom": [
    {
      "capabilities": [
        "view_all_customers"
      ],
      "scope": "company"
    }
  ],
  "grantable": [
    "view_all_customers"
  ],
  "team_scopable": [
    "view_all_customers"
  ],
  "permission_catalog": [
    {
      "capability": "view_all_customers"
    }
  ],
  "templates": [
    {
      "scope": "company"
    }
  ]
}