appointedd_list_bookings
List bookings
List bookings, newest first by default. Filter by time window (after/before), customer, service, resource, category, status or creation/update time. Each booking has its service, resource, start/end, status and the customers on it (with their notes, questions and statuses). Page with `next`. GET /bookings.
Parametersendidsafterlimitstartbeforesort_byorder_byservicesstatusestimezonecustomers+6 more
appointedd_list_customers
List customers
List customers in the CRM: name, email, phone/mobile, address, tags, custom fields, marketing opt-in. Page with `next`. GET /customers.
Parametersendidslimitstartsort_byorder_by
appointedd_get_customer
Get customer
One customer by id. GET /customers/{customer_id}.
Parameterscustomer_idrequired
appointedd_list_resources
List resources
List resources (the staff members, rooms or equipment that bookings are made for): name, assigned service ids and resource group ids. Page with `next`. GET /resources.
Parametersendidslimitstartsort_byorder_byservices
appointedd_list_resource_groups
List resource groups
List resource groups (id and name). Page with `next`. GET /resources/groups.
Parametersendidslimitstartorder_by
appointedd_list_services
List services
List services (what can be booked): name, category, durations and prices, buffers, occupancy and booking type. Page with `next`. GET /services.
Parametersendidslimitstart
appointedd_get_service
Get service
One service by id, including its booking questions, durations, prices and buffers. GET /services/{service_id}.
Parametersservice_idrequired
appointedd_list_service_categories
List service categories
List service categories (id and name). Page with `next`. GET /services/categories.
Parametersendidslimitstart
appointedd_get_service_category
Get service category
One service category by id. GET /services/categories/{category_id}.
Parameterscategory_idrequired
appointedd_find_available_intervals
Find available times
Find the start times at which a service can be booked in the given ranges, with the free resource ids for each (and existing group bookings with room). Step 1 of making a booking: pick a start, then appointedd_create_reservation. Read-only. POST /availability/intervals/search.
Parametersrangesrequiredspacesdurationtimezoneservice_idrequiredresource_idsresource_group_idsignore_service_scheduleignore_notice_restriction
appointedd_find_available_dates
Find available days
Find which days in the given ranges have any availability for a service (a calendar view; use appointedd_find_available_intervals for the times). Read-only. POST /availability/days/search.
Parametersrangesrequiredspacesdurationtimezoneservice_idrequiredresource_idsresource_group_idsignore_service_scheduleignore_notice_restriction
appointedd_get_reservation
Get reservation
One reservation (availability slot) by id: its service, resource, times and expiry. GET /availability/slots/{reservation_id}.
Parameterstimezonereservation_idrequired
appointedd_create_customer
Create customer
WRITE: create a customer in the CRM (first and last name required; email, mobile, phone, tags optional). POST /customers.
Parameterstagsemailphonemobilelastnamerequiredfirstnamerequired
appointedd_update_customer
Update customer
WRITE: change a customer's name, email, mobile, phone or tags. Only the fields you pass are sent; `tags` replaces the customer's tag list. PUT /customers/{customer_id}.
Parameterstagsemailphonemobilelastnamefirstnamecustomer_idrequired
appointedd_create_reservation
Create reservation (hold a time)
WRITE: hold a date and time for a booking (step 2). The reservation blocks that slot for `expires_after` minutes (default: the organisation's setting); then call appointedd_create_booking with the returned reservation id. Without resource_id a free resource assigned to the service is picked. POST /availability/slots.
Parametersstartrequireddurationtimezoneservice_idrequiredresource_idexpires_afterrequired_spacesresource_group_idsignore_service_scheduleignore_notice_restriction
appointedd_create_booking
Create booking
WRITE: turn an active reservation into a booking (step 3) for one or more customers; Appointedd matches each customer to the CRM by name/email/mobile or creates it. Payment requests are NOT sent unless send_payment_request is true. With an empty customers list an empty booking is created. POST /bookings.
Parameterslabeltimezonecustomersrequiredreservation_idrequiredsend_payment_request
appointedd_update_booking
Update booking
WRITE: change a booking's service, resource, label or total spaces, or move it by giving `parts` with new start/end times. Customers are NOT emailed unless send_notifications is true. PUT /bookings/{booking_id}.
Parameterslabelpartstimezonebooking_idrequiredservice_idresource_idtotal_spacessend_notificationsignore_service_schedule
appointedd_update_booking_customer
Update customer on booking
WRITE: set the arrival status (Arrived, Complete, No Show, No Status) and/or notes of one customer on a booking. customer_booking_id is the customer's `customer_booking_id` (or `customer_id`) in the booking's customers list. PUT /bookings/{booking_id}/customers/{customer_booking_id}.
Parametersnotesstatusbooking_idrequiredcustomer_booking_idrequired
appointedd_cancel_booking
Cancel booking
WRITE (cannot be undone): cancel a whole booking. Appointedd may notify the customers according to the organisation's settings. To remove one customer from a group booking use appointedd_cancel_booking_customer. POST /bookings/{booking_id}/cancel.
Parametersbooking_idrequired
appointedd_cancel_booking_customer
Cancel customer on booking
WRITE (cannot be undone): cancel one customer's place on a booking (the booking stays for the others). customer_booking_id is the `customer_booking_id` in the booking's customers list. POST /bookings/{booking_id}/customers/{customer_booking_id}/cancel.
Parametersbooking_idrequiredcustomer_booking_idrequired