Skip to content
Home/
REST API Reference
/
/
Role

Role

A role defines what a teammate can do in a workspace. The teammates endpoint returns the id and name of the role a teammate holds; this schema adds the role's description.

typestring

Value is always "role"

Example:"role"
idstring

The id of the role

Example:"991267902"
namestring

The name of the role

Example:"Support Lead"
descriptionstring or null

The description of the role

Example:"Can view and reply to conversations"
{
  "type": "role",
  "id": "991267902",
  "name": "Support Lead",
  "description": "Can view and reply to conversations"
}