Skip to content

V2 workflows and field conventions

Use these guides to connect the resources in the V2 reference and to understand the effects of write requests. They cover management integrations that use company credentials. They do not provide a client-facing booking or checkout API. For authentication, start with Getting started. If you are moving from V1, read Migrate from V1 to V2 first.

Read the table by task. Each row links to the guide and names the main endpoints.

Task Guide Main endpoints
Book classes, cancel a booking, book an appointment Book classes and appointments /bookings/, /appointments/
Schedule, update and cancel classes Schedule and cancel classes /classes/
Email or SMS clients Send an email or SMS /communications/
Read invoices and invoice items Read billing data /invoices/, /invoice-items/
Create gift cards and retail products Create catalogue items /gift-cards/, /products/, /coupons/
Update clients, notes, tags and tag groups Manage clients, notes and tags /clients/, /client-notes/, /tags/, /tag-groups/
Assign teacher pay rates Assign teacher pay rates /teachers/{id}/pay-rates/
Know what a write changes Understand updates and disabling PATCH, enable and disable actions

To find which ID goes in a field, see Find the ID you need.