Role | SavvyCal Appointments

This is an object representing a role in the system.

Example

{  "denied_permissions": [    "appointments.own.cancel",    "appointments.own.reschedule"  ],  "id": "role_123456789012",  "name": "Staff",  "object": "role",  "permissions": [    "accounts.view",    "appointments.own.*",    "blocks.*",    "booking_intents.*",    "clients.*",    "integrations.own.*",    "providers.own.view",    "providers.own.update"  ],  "type": "staff"}

denied_permissions*array<string>

Permissions explicitly denied for this role. Denials win over grants, including wildcards (e.g. denying appointments.own.cancel removes cancel even when the role has appointments.own.*). Superuser roles cannot have denials.

id*string

Unique identifier for the role.

Match^role_\w{12}$

name*string

The name of the role.

object*"role"

String representing the object's type.

Value in

"role"

permissions*array<string>

Granted permissions for this role. Built-in roles return their baseline grants; custom roles return the stored allow-list. Explicit denials are listed separately in denied_permissions and always win over grants (including wildcards).

type*string

The type of the role.

Value in

"admin"
"staff"
"superuser"
"custom"