Scopes

Scopes define the permissions of your API key.

Available Scopes

• appointments:read - View appointments
• appointments:create - Create appointments
• appointments:cancel - Cancel appointments
• departments:read - View departments
• availability:check - Check availability
• users:read - View users (limited)
• webhooks:manage - Manage webhooks
• api:admin - Full administrator access

Choose the Right Scopes

Follow the principle of least privilege: only request the scopes you actually need.

Examples

Simple booking application:

• departments:read
• appointments:create
• appointments:read

Admin dashboard:

• api:admin (or all individual scopes)