Role

object

idrequired: Id
Opaque record id.
keyrequired: string
namerequired: string
descriptionrequired: string or null
is_systemrequired: boolean
is_ownerrequired: boolean
requires_two_factorrequired: boolean
audiencerequired: "staff" | "partner"
membersrequired: integer
Active members with this role.
members_totalrequired: integer
pending_invitationsrequired: integer
can_editrequired: boolean
The caller may change this role’s permissions.
can_deleterequired: boolean
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "key": "string",
  "name": "string",
  "description": "string",
  "is_system": true,
  "is_owner": true,
  "requires_two_factor": true,
  "audience": "staff",
  "members": 0,
  "members_total": 0,
  "pending_invitations": 0,
  "can_edit": true,
  "can_delete": true,
  "updated_at": "2026-10-06T05:30:00.000Z"
}