zenbooker_list_jobs
List jobs
List jobs (booked appointments), by start time by default, with filters: customer id, assigned team member id, territory id, recurring booking id, status, canceled flag, creation time and scheduled start window. Returns { results, count, has_more, next_cursor }; pass next_cursor as cursor for the next page. GET /v1/jobs.
輸入參數limitcursorstatussort_byassignedcanceledcustomerterritorysort_ordercreated_aftercreated_beforestart_date_max另有 2 個
One job by id: appointment time, status, customer, service address, services and fields, assigned providers, notes and invoice summary. GET /v1/jobs/{id}.
輸入參數job_id必填
zenbooker_add_job_note
Add a note to a job
WRITE: add an internal note (text) to a job. Notes are appended, never replaced, and cannot be deleted through this server, so check the job first. POST /v1/jobs/{id}/notes.
輸入參數text必填job_id必填
zenbooker_list_recurring_bookings
List recurring bookings
List recurring bookings (repeating job series), by status (active or canceled), customer id, assigned team member id, territory id or creation time. Max 40 per page. Returns { results, count, has_more, next_cursor }. GET /v1/recurring.
輸入參數limitcursorstatusassignedcustomerterritorysort_ordercreated_aftercreated_before
zenbooker_get_recurring_booking
Get recurring booking
One recurring booking by id: first job date, job count, time slot, status, territory, service, pricing and its job ids. GET /v1/recurring/{id}.
輸入參數recurring_booking_id必填
zenbooker_list_customers
List customers
List or search customers by name, email or phone, by creation time, or by default address near a place (location + radius in miles). Returns { results, count, has_more, next_cursor }. GET /v1/customers.
輸入參數nameemaillimitphonecursorradiuslocationsort_ordercreated_aftercreated_before
zenbooker_get_customer
Get customer
One customer by id: contact details, notes, addresses, job and recurring booking ids and linked Stripe customer. GET /v1/customers/{id}.
輸入參數customer_id必填
zenbooker_create_customer
Create customer
WRITE: create a new customer record in Zenbooker (name required; phone and email optional). It does not look for an existing customer, so search with zenbooker_list_customers first to avoid duplicates. POST /v1/customers.
輸入參數name必填emailphone
zenbooker_list_invoices
List invoices
List invoices, optionally by status (draft, unpaid, partial_paid, paid, void), customer id, territory id or creation time. Each invoice has line items, totals, amount paid and due and its transactions. Returns { results, count, has_more, next_cursor }. GET /v1/invoices.
輸入參數limitcursorstatussort_bycustomerterritorysort_ordercreated_aftercreated_before
zenbooker_get_invoice
Get invoice
One invoice by id: recipient, line items, discounts, tax, totals, amount paid and due, status and transactions. GET /v1/invoices/{id}.
輸入參數invoice_id必填
zenbooker_list_transactions
List transactions
List payment transactions, optionally by type (stripe_payment, external_transaction), payment method, status (succeeded, failed, voided), customer id, territory id, creation time or payment date. Returns { results, count, has_more, next_cursor }. GET /v1/transactions.
輸入參數typelimitcursorstatussort_bycustomerterritorysort_ordercreated_aftercreated_beforepayment_methodtransaction_date_after另有 1 個
zenbooker_get_transaction
Get transaction
One payment transaction by id: status, type, method, amount, invoice and customer ids, Stripe references. GET /v1/transactions/{id}.
輸入參數transaction_id必填
zenbooker_list_services
List services
List the services a business offers, with pricing method, base price and duration, option sections and recurring frequencies. GET /v1/services.
輸入參數limitcursoris_visiblesort_ordercategory_idcreated_aftercreated_before
zenbooker_get_service
Get service
One service by id: pricing, duration, option sections and their options. GET /v1/services/{id}.
輸入參數service_id必填
zenbooker_list_territories
List service territories
List the service territories (areas a business serves) with timezone, service area, providers and operating hours. Use the ids to filter jobs and invoices or to look up time slots. GET /v1/territories.
輸入參數namelimitcursorenabledsort_ordercreated_aftercreated_before
zenbooker_get_territory
Get service territory
One service territory by id. GET /v1/territories/{id}.
輸入參數territory_id必填
zenbooker_list_team_members
List team members
List team members (staff and service providers) with role, status, assigned territories, skill tags and work hours. Use the ids to filter jobs by assigned provider. GET /v1/team_members.
輸入參數emaillimitcursorterritorysort_orderdeactivatedcreated_aftercreated_beforeservice_provider
zenbooker_get_team_member
Get team member
One team member by id: contact details, role, status, territories, skill tags and work hours. GET /v1/team_members/{id}.
輸入參數team_member_id必填
zenbooker_list_service_requests
List service requests
List incoming service requests (booking requests and quote requests) with status, customer, territory, duration, requested dates, services and pricing. Returns { results, count, has_more, next_cursor }. GET /v1/service_requests.
輸入參數limitcursorcustomerterritorysort_orderrequest_typecreated_aftercreated_before
zenbooker_check_service_area
Check service area
Check whether a location is inside the business's service area: returns in_service_area, the matching territory and other territories that serve it (or the closest territory when it is outside every area). Give a postal code, an address, or lat + lng. GET /v1/scheduling/service_area_check.
輸入參數latlngaddresspostal_code
zenbooker_get_timeslots
Get available time slots
Available booking time slots for a service territory, grouped by day (days[].timeslots[] with start, end and id). Needs the territory id (zenbooker_list_territories or zenbooker_check_service_area) and the service duration in minutes. GET /v1/scheduling/timeslots.
輸入參數latlngdatedaysduration必填territory必填required_skillsservice_providerstimeslot_templatemin_providers_needed