waitwhile_list_locations
List locations
List the account's locations (businesses/sites): id, name, short name, address, time zone, opening hours and waitlist/booking settings. Use the ids to filter visits, services and resources. GET /locations.
輸入參數desclimitexternal_idstart_aftercountry_code
waitwhile_get_location
Get location
One location by id or short name (the part of its public Waitwhile URL). GET /locations/{shortNameOrId}.
輸入參數location必填
waitwhile_list_location_status
List location status (live waitlist)
Live status of every location: open/closed, number of people waiting and being served, current estimated wait time, and booking counters. GET /location-status.
輸入參數limitstart_after
waitwhile_get_location_status
Get location status (live waitlist)
Live status of one location: open/closed, waiting and serving counts, estimated wait. GET /location-status/{locationId}.
輸入參數location_id必填
waitwhile_list_visits
List visits (waitlist entries and bookings)
List visits: waitlist entries (people in line) and bookings (appointments), with customer, state (PENDING, DRAFT, BOOKED, WAITING, SERVING, COMPLETE), tags (e.g. NO-SHOW, CANCELLED, ARRIVED), services, resources, party size, position and timestamps. Filter by location, state, tag, customer, service, resource, booking date (local time) or created/updated date. Cursor-paged. Contains customer contact details. GET /visits.
輸入參數tagdesclimitstateto_datefrom_dateservice_idcustomer_idlocation_idresource_idstart_afterto_booking_date另有 2 個
waitwhile_search_visits
Search visits
Search visits by a prefix match on customer name, phone, e-mail or customer id, optionally filtered by location, state, tag and excluded tags. Page-numbered. Contains customer contact details. GET /visits/search.
輸入參數q必填tagpagelimitstatelocation_idexclude_tags
waitwhile_get_visit
Get visit
One visit (waitlist entry or booking) by id: customer, state, tags, services, resources, party size, position, estimated wait and all timestamps. GET /visits/{visitId}.
輸入參數visit_id必填
waitwhile_list_booking_slots
List booking slots
Booking slots of a location for a date range with the free spots per resource and service, so you can see when an appointment can be booked. Dates are local to the location, YYYY-MM-DDThh:mm. GET /visits/availability.
輸入參數to_datefrom_datelocation_id必填service_idsresource_idsshow_min_spotsservice_duration
waitwhile_first_available_slots
First available booking slots
The first available booking slots of a location (optionally for a party size, services and resources) from a date. Use it to propose appointment times. GET /visits/first-available-slots.
輸入參數to_datefrom_dateparty_sizelocation_id必填service_idsresource_idsmax_num_slotsservice_duration
waitwhile_list_customers
List customers
List customers (name, phone, e-mail, tags, last visit per location, created/updated). Cursor-paged, 20 per page by default; filter by location, external id or created/updated date. Contains personal data. GET /customers.
輸入參數desclimitto_datefrom_dateexternal_idlocation_idstart_after
waitwhile_search_customers
Search customers
Search customers by a prefix match on name, phone, e-mail or customer id; optionally narrowed by location, visit state or tag. Page-numbered. Contains personal data. GET /customers/search.
輸入參數q必填tagpagelimitstatelocation_id
waitwhile_get_customer
Get customer
One customer by id: contact details, tags, per-location state and last visit. Contains personal data. GET /customers/{customerId}.
輸入參數customer_id必填
waitwhile_list_customer_notes
List customer notes
The staff notes recorded on a customer (content, author, visit and location, timestamps). GET /customers/{customerId}/notes.
輸入參數customer_id必填
waitwhile_list_services
List services
List services (what customers book or queue for): name, duration, price, locations, resources and category structure. GET /services.
輸入參數qlimitparent_idexternal_idis_categorylocation_idstart_after
waitwhile_get_service
Get service
One service by id. GET /services/{serviceId}.
輸入參數service_id必填
waitwhile_list_resources
List resources (staff, rooms, tables)
List resources — the people, rooms, tables or equipment that serve customers: name, locations, services, availability flag and category structure. GET /resources.
輸入參數qemaillimitparent_idexternal_idis_categorylocation_idstart_after
waitwhile_get_resource
Get resource
One resource by id. GET /resources/{resourceId}.
輸入參數resource_id必填
waitwhile_resources_availability
Resource availability
Working hours/availability of a location's resources on a date (e.g. who is working today). GET /resources/availability.
輸入參數datelocation_id必填resource_ids
waitwhile_list_data_fields
List data fields (intake form fields)
List the custom data fields (intake/booking form questions) with type, options and where they apply. Use the ids to read answers on visits. GET /data-fields.
輸入參數qlimitexternal_idlocation_idstart_after
waitwhile_get_data_field
Get data field
One data field by id. GET /data-fields/{dataFieldId}.
輸入參數data_field_id必填
waitwhile_list_users
List users (staff)
List the staff users of the account: name, e-mail, roles, locations. Password data and tokens are never returned. GET /users.
輸入參數qrolelimitexternal_idlocation_idstart_after
waitwhile_list_messages
List messages
List the SMS/e-mail messages Waitwhile sent to and received from customers: channel, recipient, body, delivery state (PENDING, BLOCKED, FAILED, DELIVERED, UNCONFIRMED, RECEIVED) and error. Filter by location, visit, customer, state or date. Contains personal data. This only reads; it cannot send. GET /messages.
輸入參數desclimitstateto_datevisit_idfrom_datecustomer_idlocation_idstart_afterexternal_customer_id
waitwhile_get_message
Get message
One message by id. Contains personal data. GET /messages/{messageId}.
輸入參數message_id必填
waitwhile_visit_analytics
Visit analytics
Aggregated visit statistics for a period: visits, waitlisted, bookings, served, no-shows, cancellations, wait and serve duration quantiles, and breakdowns by location, resource, service, party size, user, day of week and hour of day. GET /analytics/visits (JSON).
輸入參數to_datefrom_datelocation_id
waitwhile_list_audit_entries
List audit entries
The account's audit log: who changed what and when (visits, customers, locations, services, resources, users, messages). Filter by type, event, entity, location or date. GET /audit-entries.
輸入參數desctypeeventlimitto_dateentity_idfrom_datelocation_idstart_after
waitwhile_create_visit
Add a customer to the waitlist or create a booking
WRITE: create ONE visit at a location. Without a date it adds the customer to the waitlist; with a local date-time (YYYY-MM-DDThh:mm) it creates a booking. Needs a location and at least a name, phone or e-mail. Not idempotent: calling it twice creates two visits. Visit notes are not supported here (the field is deprecated): use waitwhile_add_customer_note. By default the request asks Waitwhile to suppress the customer message; this may only stop the immediate confirmation, and scheduled reminders/follow-ups can still go out per the location's settings. With send_notifications=true Waitwhile may text/e-mail this ONE customer. POST /visits.
輸入參數datenameemailphonedurationlast_namefirst_nameparty_sizelocation_id必填service_idsresource_idssend_notifications
waitwhile_update_visit
Update a visit (state, tags, time, party)
WRITE: change ONE visit — its state (e.g. WAITING to SERVING to COMPLETE, or BOOKED), add/remove tags (e.g. ARRIVED, CONFIRMED, NO-SHOW), booking date/duration or party size. Only the fields you pass change. By default the request asks Waitwhile to suppress the customer message; this may only stop the immediate status message, and scheduled reminders/follow-ups can still go out per the location's settings. With send_notifications=true Waitwhile may text/e-mail this ONE customer. Use waitwhile_cancel_visit to cancel. POST /visits/{visitId}.
輸入參數datestateadd_tagsdurationvisit_id必填party_sizeremove_tagssend_notifications
waitwhile_cancel_visit
Cancel a visit
WRITE: cancel ONE visit (a waitlist entry or booking). Waitwhile sets its state to COMPLETE and adds the CANCELLED tag; the visit is kept, not deleted. By default the request asks Waitwhile to suppress the customer message; this may only stop the immediate cancellation notice, and scheduled reminders/follow-ups can still go out per the location's settings. With send_notifications=true Waitwhile may text/e-mail this ONE customer. POST /visits/{visitId}/cancel.
輸入參數visit_id必填send_notifications
waitwhile_add_customer_note
Add a customer note
WRITE: add one staff note to a customer's record (optionally tied to a visit and location). Adds only; nothing is edited or sent to the customer. POST /customers/{customerId}/notes.
輸入參數content必填visit_idcustomer_id必填location_id