Skip to main content

Resources

Every route in the API. See Authentication & Scopes for what a scope grants, and Errors for the shape a failed call returns.

Prefer a structured, searchable reference with full request/response schemas? See the API Reference.

Public — no key required​

MethodPathDetail
GET/public/{handle}Public Surface
GET/public/{handle}/booking-typesPublic Surface
GET/public/{handle}/booking-types/{id}/availabilityPublic Surface
GET/public/{handle}/postsPublic Surface
POST/public/{handle}/bookingsPublic Surface

Bookings — bookings:read / bookings:write / bookings:override​

MethodPathScopeDetail
GET/bookingsbookings:readBookings
POST/bookingsbookings:write (+ bookings:override)Bookings
GET/bookings/{id}bookings:readBookings
PATCH/bookings/{id}bookings:writeBookings
POST/bookings/{id}/cancelbookings:writeBookings
POST/bookings/{id}/check-inbookings:writeBookings
POST/bookings/{id}/paymentbookings:writeBookings

Booking types — booking_types:read​

MethodPathScopeDetail
GET/booking-typesbooking_types:readBooking Types
GET/booking-types/{id}booking_types:readBooking Types

Members — members:read / members:write​

MethodPathScopeDetail
GET/membersmembers:readMembers
GET/members/{id}members:readMembers
POST/membersmembers:writeMembers
PATCH/members/{id}members:writeMembers

Memberships & plans — memberships:read / memberships:write​

MethodPathScopeDetail
GET/membership-plansmemberships:readMemberships & Plans
GET/membership-plans/{id}memberships:readMemberships & Plans
GET/membershipsmemberships:readMemberships & Plans
POST/membershipsmemberships:writeMemberships & Plans
PATCH/memberships/{id}memberships:writeMemberships & Plans
POST/memberships/{id}/cancelmemberships:writeMemberships & Plans
POST/memberships/{id}/pausememberships:writeMemberships & Plans
POST/memberships/{id}/resumememberships:writeMemberships & Plans
POST/memberships/{id}/paymentmemberships:writeMemberships & Plans

Your key — no extra scope​

MethodPathDetail
GET/meAuthentication & Scopes