intakeq_list_clients
Search clients
Search the practice's clients (patients) by name, email or client number, by created/updated date range, by external id, or by a custom field. Without include_profile it returns Name, Email, Phone and ClientNumber; with include_profile=true it returns the full profile (address, insurance, tags, custom fields, linked clients). Max 100 per page. IntakeQ: GET /clients.
輸入參數pagesearchdeleted_onlycustom_fieldsinclude_profiledate_created_enddate_updated_enddate_created_startdate_updated_startexternal_client_id
intakeq_get_client_diagnoses
Get a client's diagnoses
List the diagnoses recorded for one client: code, description, start/end date and the treatment note they came from. IntakeQ: GET /client/{clientId}/diagnoses.
輸入參數client_id必填
intakeq_list_appointments
List appointments
Query appointments by client name/email, date range, status, practitioner or last-modified date. Max 100 per page. IntakeQ: GET /appointments.
輸入參數pageclientstatusend_datestart_datedeleted_onlyupdated_sincepractitioner_email
intakeq_get_appointment
Get one appointment
Fetch one appointment: client, practitioner, service, location, start/end, status, price, invoice, telehealth link and cancellation details. IntakeQ: GET /appointments/{id}.
輸入參數appointment_id必填
intakeq_get_booking_settings
Get booking settings
List the scheduler's locations, services (with duration and price) and practitioners — the ids you need to create an appointment. IntakeQ: GET /appointments/settings.
無需輸入參數。
intakeq_list_intakes
List intake forms
Query submitted intake questionnaires (summaries: client, status, questionnaire, practitioner, dates). By default only completed forms; set all=true for every status (Sent, Partial, Completed, Offline). Max 100 per page. IntakeQ: GET /intakes/summary.
輸入參數allpageclientend_dateclient_idstart_datedeleted_onlyupdated_sinceexternal_client_id
intakeq_get_intake
Get a full intake form
Fetch one intake questionnaire with every question and answer, its consent forms and linked appointment. IntakeQ: GET /intakes/{id}.
輸入參數intake_id必填
intakeq_list_questionnaires
List questionnaire templates
List the intake questionnaire templates in the account (id, name, archived, anonymous) — the ids you need to send one. IntakeQ: GET /questionnaires.
無需輸入參數。
intakeq_list_practitioners
List practitioners
List the practitioners in the account (id, name, email, external id). IntakeQ: GET /practitioners.
無需輸入參數。
intakeq_list_notes
List treatment notes
Query treatment note summaries by client, lock status, date range or last-updated date. Max 100 per page. IntakeQ: GET /notes/summary.
輸入參數pageclientstatusend_dateclient_idstart_datedeleted_onlyupdated_since
intakeq_get_note
Get a full treatment note
Fetch one treatment note with every question and answer and its linked appointment. IntakeQ: GET /notes/{id}.
輸入參數note_id必填
intakeq_list_invoices
List invoices
Query invoices by client, issue date range, status, practitioner or last-updated range. Each invoice includes items, payments and amounts due/paid. Max 100 per page. IntakeQ: GET /invoices.
輸入參數pagestatusend_dateclient_idstart_datepractitioner_emaillast_updated_end_datelast_updated_start_date
intakeq_get_invoice
Get one invoice
Fetch one invoice: line items, taxes, discounts, payments, totals and amount due. IntakeQ: GET /invoices/{id}.
輸入參數invoice_id必填
intakeq_save_client
Create or update a client
Create a client, or update one. With ClientId the existing client is updated. WITHOUT ClientId IntakeQ still tries to match an existing client by first name + email (or first name + phone) and updates that one instead of creating a duplicate. For updates, fetch the full profile first (intakeq_list_clients with include_profile=true) and send it back with your changes, so no field is unintentionally cleared. Field names are IntakeQ's own. Dates are Unix timestamps in milliseconds. IntakeQ: POST /clients.
輸入參數CityNameEmailPhoneGenderAddressCountryArchivedClientIdLastNameFirstNameHomePhone另有 25 個
intakeq_add_client_tag
Tag a client
Add a tag to a client. The tag is created if it does not exist; adding one the client already has is a no-op. IntakeQ: POST /clientTags.
輸入參數tag必填client_id必填
intakeq_create_appointment
Create an appointment
Book an appointment in the PracticeQ scheduler. Get PractitionerId, ServiceId and LocationId from intakeq_get_booking_settings. All fields are required by IntakeQ. Status must be Confirmed or WaitingConfirmation; SendClientEmailNotification may be true only when Status is Confirmed. IntakeQ: POST /appointments.
輸入參數Status必填ClientId必填ServiceId必填LocationId必填UtcDateTime必填ReminderType必填PractitionerId必填SendClientEmailNotification必填
intakeq_update_appointment
Update or reschedule an appointment
Change an appointment's time, service, location, status or reminder type. Id and UtcDateTime are required (send the current time to keep it); include only the other fields you are changing. The client and practitioner cannot be changed, and a Confirmed appointment cannot go back to WaitingConfirmation. IntakeQ: PUT /appointments.
輸入參數Id必填StatusServiceIdLocationIdUtcDateTime必填ReminderTypeSendClientEmailNotification
intakeq_cancel_appointment
Cancel an appointment
Cancel an appointment, with an optional reason. This changes the client's booking and cannot be undone through the API — book a new appointment to replace it. IntakeQ: POST /appointments/cancellation.
輸入參數reasonappointment_id必填
intakeq_send_questionnaire
Send an intake questionnaire
Send an intake questionnaire to a client by email or SMS. This MESSAGES THE CLIENT. Identify the client by ClientId, or by ClientName plus ClientEmail and/or ClientPhone (omit ClientEmail to force SMS). PractitionerId is optional. Returns the new intake. IntakeQ: POST /intakes/send.
輸入參數ClientIdClientNameClientEmailClientPhonePractitionerIdQuestionnaireId必填ExternalClientId
