practice_better_get_account
Get my account
The practitioner (API user) behind this connection: id, name, title, timezone, default currency, role flags and the practice (company) id and name. Settings, integrations and the bio are not returned. GET /consultant/profile.
无需输入参数。
practice_better_list_practitioners
List practitioners
List the practitioners and admin users of the practice, with id, name, role flags and activation status. Use the ids to filter sessions and invoices. GET /company/administration/members.
无需输入参数。
practice_better_list_clients
List clients
List client records, newest first: id, status, name, email, phone, timezone and activity dates. Date of birth, address, insurance and notes are not returned. A page holds at most 100 records. To look up one person by name or email use practice_better_find_clients. GET /consultant/records.
输入参数limitstatusafter_idbefore_idhas_accountchild_recordsmodified_aftermodified_before
practice_better_find_clients
Find clients by name or email
Search client records by name, preferred name or email (case-insensitive text match). Practice Better has no search endpoint, so this reads the 500 most recent records (5 pages of 100) and filters them; `complete` says whether every record was checked. Returns at most `max_results` matches with the same fields as practice_better_list_clients. GET /consultant/records.
输入参数query必填statusmax_results
practice_better_get_client
Get client
One client record by id: status, name, preferred name, pronouns, email, phones, timezone, activity dates and tag ids. Date of birth, address, insurance, emergency contacts, notes and health history are not returned. GET /consultant/records/{recordId}.
输入参数record_id必填
practice_better_list_sessions
List sessions (appointments)
List sessions (appointments), newest first: date, duration, service, practitioner, client (id and name), status and payment status. Booking notes and session notes are not returned. Filter by date range, practitioner, client record, service or group/1-1. GET /consultant/sessions.
输入参数grouplimitafter_idbefore_iddate_afterrecord_idsdate_beforeservice_idspractitioner_ids
practice_better_get_session
Get session
One session (appointment) by id: date, duration, service, practitioner, client (id and name), location and status. Booking notes and session notes are not returned. For a group session pass record_id to see one client's view. GET /consultant/sessions/{sessionId}.
输入参数record_idsession_id必填
practice_better_get_availability
Get available time slots
Open booking slots of one practitioner for one service, starting on the given day: start, end and duration of each slot. It follows the practitioner's booking settings. Needs a practitioner id and a service id. GET /consultant/availability/slots.
输入参数day必填typepackage_idservice_id必填location_idpractitioner_id必填
practice_better_list_services
List services
List the services (appointment types) the practice offers: id, name, duration, group or 1-1, session types and SKU. GET /consultant/services.
输入参数limitafter_idteam_forbefore_id
practice_better_list_packages
List packages
List the package definitions (bundles of sessions or programs) the practice sells: id, name and SKU. GET /consultant/packages.
输入参数limitafter_idbefore_id
practice_better_list_tags
List tags
List the tags the practice uses to organize clients: id and name. A client record carries tag ids. GET /tags.
输入参数limitafter_idbefore_id
practice_better_list_invoices
List invoices
List client invoices, newest first: number, date, totals, amount due and paid, payment status, client (id and name) and practitioner. Payment history and line items are not in the list; use practice_better_get_invoice. GET /consultant/payments/invoices.
输入参数limitafter_idbefore_idrecord_idspayment_statuspractitioner_idsinvoice_date_afterinvoice_date_before
practice_better_get_invoice
Get invoice
One invoice by id with its line items (date, quantity, amount, tax) and totals. Descriptions, payment history and billing contact are not returned. GET /consultant/payments/invoices/{invoiceId}.
输入参数invoice_id必填
practice_better_list_forms
List forms
List the form templates of the practice (intake forms, questionnaires, consent forms): id and name only. GET /consultant/forms.
输入参数limitafter_idteam_forbefore_id
practice_better_list_form_requests
List form requests
List forms sent to clients, newest first: which form, which client (id), practitioner, and whether it was started or completed, with dates. The answers are never returned. GET /consultant/formrequests.
输入参数limitafter_idbefore_idcompletedrecord_idscreated_aftercreated_beforepractitioner_ids