Skip to main content

Scopes

Scopes define the permissions of your API key.

Available Scopes​

  • READ_APPOINTMENTS - View appointments
  • WRITE_APPOINTMENTS - Create and update appointments
  • CANCEL_APPOINTMENTS - Cancel appointments
  • READ_DEPARTMENTS - View departments
  • READ_AVAILABILITY - Check availability
  • READ_USERS - View users (limited)
  • READ_ORGANIZATIONS - View organization information

There is no "full administrator" scope: an API key must always be granted each scope it needs explicitly (least privilege is enforced by default).

Choose the Right Scopes​

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

Examples​

Simple booking application:

  • READ_DEPARTMENTS
  • WRITE_APPOINTMENTS
  • READ_APPOINTMENTS

Admin dashboard:

  • All the individual scopes you need (READ_APPOINTMENTS, WRITE_APPOINTMENTS, CANCEL_APPOINTMENTS, READ_DEPARTMENTS, READ_AVAILABILITY, READ_USERS, READ_ORGANIZATIONS)
Last updated on