Practice Better
App · 25 actions
Connect Practice Better to manage your account records and automate everyday work.
Actions
| Action | What it does |
|---|---|
| Book session | Book a Session. |
| Cancel session | Cancel a Session. |
| Create client | Create Client Record. |
| Get available slots | Get Availability Slots. |
| Get client | Get Client Record. |
| Get form request | Get Form Request. |
| Get invoice | Get Invoice. |
| Get profile | Get Consultant Profile. |
| Get program | Get Program. |
| Get session | Get Session. |
| List client packages | List Client Packages. |
| List clients | List Client Records. |
| List form requests | List Form Requests. |
| List forms | List Forms. |
| List invoices | List Invoices. |
| List packages | List Package Definitions. |
| List programs | List Programs. |
| List services | List Services. |
| List sessions | List Sessions. |
| List tags | List Tags. |
| List tasks | List Tasks. |
| List webhook deliveries | List deliveries. |
| List webhook event types | List available event types. |
| List webhook subscriptions | List subscriptions. |
| Send forms | Create Form Requests. |
Book session
Book a Session.
Inputs
- As consultant ID
as_consultant_idtext - The ID of the consultant assigned to the client's session.
- Buffer
bufferobject - Buffer for this request.
- Client record ID
client_record_idtextRequired - The unique identifier of the client record.
- Duration
durationnumber - The duration of the session in seconds, e.g. 900 for a 15 minute session. If omitted, defaults to the duration of the service.
- Fee
feeobject - Fee for this request.
- Ignore conflict
ignore_conflicttrue/false - If true, will book session despite potential conflicts in practitioner's calendar.
- Location
locationobject - Location for this request.
- Mark confirmed
mark_confirmedtrue/false - Mark session as client-confirmed, avoids seeing "Confirm" button in email.
- Notes
notestext - Notes for this request.
- Notification options
notification_optionsobject - Notification options for this request.
- Notify
notifytrue/false - If false, will not send a confirmation notification to the client.
- Service
service_idtextRequired - The unique identifier of the service.
- Service type
service_typetextRequired - How the session will be conducted. One of face (in-person), phone, virtual (telehealth). If type is virtual you must also set the launchApplication property under telehealthSettings.
- Session date
session_datedate and timeRequired - The date and time of the session.
- Telehealth settings
telehealth_settingsobject - Telehealth settings for this request.
- Time zone
time_zonetext - The timezone of the booking time. The value should be the name of the timezone e.g Pacific Standard Time. For a list of valid values see [List Timezones](/operations/TimeZone_List)
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"actualDuration": 1,
"buffer": {
"after": 1,
"before": 1
},
"cancellable": false,
"cancelled": false,
"clientConfirmationStatus": "example",
"clientRecord": {
"client": {
"dateCreated": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"profile": {}
},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {
"address": {},
"dateOfBirth": "2026-10-01T12:00:00Z",
"dayOfBirth": "example",
"emailAddress": "example",
"emergencyContacts": [],
"firstName": "example",
"gender": "example",
"genderIdentity": "example",
"healthInsuranceProfile": {},
"healthcareProviders": [],
"homePhone": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"mobilePhone": "example",
"notes": "example",
"occupation": "example",
"patientAccountNumber": "example",
"preferredName": "example",
"pronouns": "example",
"referredBy": "example",
"secondaryContacts": [],
"timeZone": "example",
"title": "example",
"workHoursPerWeek": 1,
"workPhone": "example"
},
"relatedTags": [],
"status": "example"
},
"confirmationStatus": "example",
"consultant": {
"company": {
"businessNumber": "example",
"businessNumberType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"id": "example",
"managedBillingEnabled": false,
"name": "example",
"theme": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {
"defaultCurrency": "example",
"firstName": "example",
"lastName": "example",
"timeZone": "example",
"title": "example"
}
},
"dateConfirmed": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"endDate": "2026-10-01T12:00:00Z",
"fee": {
"amount": 1,
"currency": "example"
},
"hasRecording": false,
"id": "example",
"insurancePoliciesChecked": [],
"internalNotesHistory": [],
"isRecurring": false,
"isSubscription": false,
"location": {
"address": "example",
"clientBookingEnabled": false,
"cmsPlaceOfService": {
"code": "example",
"description": "example"
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"faxNumber": "example",
"flexible": false,
"fullAddress": {
"country": "example",
"floor": "example",
"locality": "example",
"postalCode": "example",
"region": "example",
"street": "example",
"unit": "example"
},
"id": "example",
"isDefault": false,
"name": "example",
"notes": "example",
"npiNumber": "example",
"otherId": "example",
"otherIdQualifier": "example",
"phoneNumber": "example",
"room": "example",
"suggested": false,
"website": "example"
},
"notes": "example",
"notesHistory": [],
"paymentStatus": "example",
"service": {
"consultant": {
"company": {},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"id": "example",
"isGroupService": false,
"name": "example",
"serviceTypes": [],
"sku": "example"
},
"serviceType": "example",
"sessionDate": "2026-10-01T12:00:00Z",
"sessionNotes": {
"artifacts": [],
"booking": {
"actualDuration": 1,
"buffer": {},
"cancellable": false,
"cancelled": false,
"confirmationStatus": "example",
"consultant": {},
"dateConfirmed": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"endDate": "2026-10-01T12:00:00Z",
"fee": {},
"hasRecording": false,
"id": "example",
"insurancePoliciesChecked": [],
"internalNotesHistory": [],
"isRecurring": false,
"isSubscription": false,
"location": {},
"notes": "example",
"notesHistory": [],
"paymentStatus": "example",
"service": {},
"serviceType": "example",
"sessionDate": "2026-10-01T12:00:00Z",
"sessionNotes": {},
"timeZone": "example",
"upcoming": false
},
"clientRecord": {
"client": {},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {},
"relatedTags": [],
"status": "example"
},
"completionStatus": "example",
"consultant": {
"company": {},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {}
},
"content": [],
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"datePrepared": "2026-10-01T12:00:00Z",
"diagnosisCodes": [],
"diagnosisCodesPublishStatus": "example",
"hasCosignReminder": false,
"id": "example",
"isArchived": false,
"isCosigned": false,
"labRequests": [],
"name": "example",
"notes": "example",
"procedureCodes": [],
"procedureCodesPublishStatus": "example",
"protocols": [],
"publishStatus": "example",
"reminders": [],
"revision": 1,
"sessionDate": "2026-10-01T12:00:00Z",
"summary": "example"
},
"timeZone": "example",
"upcoming": false
},
"has_more": false,
"next_cursor": null
}Cancel session
Cancel a Session.
Inputs
- Session ID
session_idtextRequired - The unique session Identifier
- Cancel pending bookings
cancel_pending_bookingstrue/false - If true, cancels upcoming sessions and session requests that have not been accepted.
- Cancel recurring automations
cancel_recurring_automationstrue/false - If true, cancels any active payment plans associated with the client's package.
- Notes
notestext - An optional note to include in the cancellation notification.
- Notify
notifytrue/false - If true, a notification will be sent to this client about the cancellation.
Outputs
Value.
datanull- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}Create client
Create Client Record.
Inputs
- Documents folder
documents_foldertrue/false - Create a documents folder for the client.
- Food journal options
food_journal_optionsobject - Food journal options for this request.
- Food mood journal
food_mood_journaltrue/false - Give the client access to the Food & Mood Journal.
- Form IDs
form_idslist - A list of form IDs for the client to complete. An email will be sent to the client with instructions to complete the forms.
- Is active
is_activetrue/false - True if the client should have access to Client Portal. [Learn More](https://help.practicebetter.io/hc/en-us/articles/232319108-Deactivating-and-reactivating-clients)
- Lifestyle journal
lifestyle_journaltrue/false - Give the client access to the Lifestyle Journal.
- Lifestyle journal options
lifestyle_journal_optionsobject - Lifestyle journal options for this request.
- Parent record ID
parent_record_idtext - If provided, the client record will created as a sub-record/child of the record with this ID. [Learn More](https://help.practicebetter.io/hc/en-us/articles/115007154147-Working-with-Family-Records)
- Address
addressobject - Address for this request.
- Date of birth
date_of_birthdate - This is a legacy field. Use dayOfBirth instead. Null if not set.
- Day of birth
day_of_birthtext - Day of birth for this request.
- Email address
email_addresstextRequired - The email address of this client.
- Emergency contacts
emergency_contactslist - The list of emergency contacts for this client. Null or empty if none are set.
- First name
first_nametextRequired - The first name of this client.
- Gender
gendertext - This is a legacy field. Use genderIdentity instead. Null if not set.
- Gender IDentity
gender_identitytext - The client's gender identity. Possible values are Man/Boy Woman/Girl Non-binary Agender Genderfluid Genderqueer Prefer not to say, or a custom value. Null if not set.
- Healthcare providers
healthcare_providerslist - The list of referring or treating healthcare providers for this client. Null or empty if none are set.
- Health insurance profile
health_insurance_profileobject - Health insurance profile for this request.
- Home phone
home_phonetext - The home phone number of this client. Used as this client's primary phone number if mobilePhone is not set. Null if not set.
- Last name
last_nametextRequired - The last name of this client.
- Marital status
marital_statustext - The client's marital status. Possible values are single commonlaw married partnered separated divorced widowed. Null if not set.
- Middle name
middle_nametext - The middle name of this client. Null if not set.
- Mobile phone
mobile_phonetext - The mobile phone number of this client. Takes precedence over homePhone and workPhone as this client's primary phone number. Null if not set. Use international format if outside Canada/US. [Learn more](https://help.practicebetter.io/hc/en-us/articles/360001694272)
- Notes
notestext - Free-text internal notes about this client, not visible to the client. Null if not set.
- Occupation
occupationtext - The occupation of this client. Null if not set.
- Patient account number
patient_account_numbertext - A patient/client identifier used to populate line 26 of the CMS 1500 form. Null if not set.
- Preferred name
preferred_nametext - The preferred name or nickname of this client. Null if not set.
- Pronouns
pronounstext - The client's pronouns. Possible values are He/Him She/Her They/Them No Pronouns, or a custom value. Null if not set.
- Referred by
referred_bytext - The source this client was referred from. Null if not set.
- Secondary contacts
secondary_contactslist - The list of secondary (non-emergency) contacts for this client. Null or empty if none are set.
- Time zone
time_zonetext - The time zone of this client, using Windows Standard time zone names (e.g. Eastern Standard Time). Null if not set.
- Title
titletext - The client's title. Possible values are Mr Mr. Ms Ms. Mrs Mrs. Miss Dr Dr. Prof Prof., or a custom value. Null if not set.
- Work hours per week
work_hours_per_weeknumber - The number of hours this client works per week. Null if not set.
- Work phone
work_phonetext - The work phone number of this client. Used as this client's primary phone number if neither mobilePhone nor homePhone is set. Null if not set.
- Send invitation
send_invitationtrue/false - Send an email invitation to the client to join Practice Better.
- Send nutri q
send_nutri_qtrue/false - Flag to send the NTA NAQ form to the client (via [Nutritional Therapy Association Integration]))
- Send nutri qv2
send_nutri_qv2true/false - Flag to send the NTA NAQ V2 form to the client (via [Nutritional Therapy Association Integration]))
- Send wellness questionnaire
send_wellness_questionnairetrue/false - Flag to send the Wellness Questionnaire form to the client (via [Whole Practice Integration](https://help.practicebetter.io/hc/en-us/articles/360056998212))
- Tag actions
tag_actionsobject - Tag actions for this request.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"client": {
"dateCreated": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"profile": {
"timeZone": "example"
}
},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {
"address": {
"country": "example",
"floor": "example",
"locality": "example",
"postalCode": "example",
"region": "example",
"street": "example",
"unit": "example"
},
"dateOfBirth": "2026-10-01T12:00:00Z",
"dayOfBirth": "example",
"emailAddress": "example",
"emergencyContacts": [],
"firstName": "example",
"gender": "example",
"genderIdentity": "example",
"healthInsuranceProfile": {
"id": "example",
"policies": []
},
"healthcareProviders": [],
"homePhone": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"mobilePhone": "example",
"notes": "example",
"occupation": "example",
"patientAccountNumber": "example",
"preferredName": "example",
"pronouns": "example",
"referredBy": "example",
"secondaryContacts": [],
"timeZone": "example",
"title": "example",
"workHoursPerWeek": 1,
"workPhone": "example"
},
"relatedTags": [],
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get available slots
Get Availability Slots.
Inputs
- As consultant
as_consultanttextRequired - The ID of the consultant.
- Day
daydate and timeRequired - The start date for checking the availability. The API will return availability slots beginning on this date spanning 31 days.
- Location
locationtext - The unique identifier of the location. If included, will additionally filter results based on location restrictions. See [Managing Availability](https://help.practicebetter.io/hc/en-us/articles/231968947-Managing-Your-Availability#h_ce737ff2-3447-4b5c-be99-55230cae6f01) and [Working with Multiple Locations](https://help.practicebetter.io/hc/en-us/articles/360000569011-Working-with-Multiple-Locations)
- Package
packagetext - The unique identifier of a client package. If included will additionally filter results based on the package expiry date. See [Package Expiry Dates](https://help.practicebetter.io/hc/en-us/articles/115002329552-Working-with-Packages#h_01EPN2ZTYDYD6D4HXJNDM5F29P)
- Service
service_idtextRequired - The unique identifier of the service. The availability slots are based on the service.
- Type
typetext - One of face (in-person), phone, virtual (telehealth). If included, will additionally filter results based on the service-method. See [Managing Availability](https://help.practicebetter.io/hc/en-us/articles/231968947-Managing-Your-Availability#h_ce737ff2-3447-4b5c-be99-55230cae6f01)
Outputs
Value.
datalist- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}Get client
Get Client Record.
Inputs
- Record ID
record_idtextRequired - The unique identifier of the client record.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"client": {
"dateCreated": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"profile": {
"timeZone": "example"
}
},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {
"address": {
"country": "example",
"floor": "example",
"locality": "example",
"postalCode": "example",
"region": "example",
"street": "example",
"unit": "example"
},
"dateOfBirth": "2026-10-01T12:00:00Z",
"dayOfBirth": "example",
"emailAddress": "example",
"emergencyContacts": [],
"firstName": "example",
"gender": "example",
"genderIdentity": "example",
"healthInsuranceProfile": {
"id": "example",
"policies": []
},
"healthcareProviders": [],
"homePhone": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"mobilePhone": "example",
"notes": "example",
"occupation": "example",
"patientAccountNumber": "example",
"preferredName": "example",
"pronouns": "example",
"referredBy": "example",
"secondaryContacts": [],
"timeZone": "example",
"title": "example",
"workHoursPerWeek": 1,
"workPhone": "example"
},
"relatedTags": [],
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get form request
Get Form Request.
Inputs
- Alt
alttext - Set to media or pdf to download the completed form as a PDF, excel to download it as a spreadsheet (the form must be completed), or signature to download the client's signature image (the form must have a signature). Omit to receive JSON.
- Notes
notestrue/false - Include form notes in the form request.
- Request ID
request_idtextRequired - The unique identifier of the form request.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"clientRecord": {
"id": "example"
},
"completed": false,
"completedForm": {
"aggregates": [],
"answers": [],
"attachments": [],
"consent": {
"consentProvided": false,
"consentRequest": {},
"dateConsented": "2026-10-01T12:00:00Z",
"id": "example",
"name": "example",
"signature": {}
},
"consents": [],
"dateCreated": "2026-10-01T12:00:00Z",
"form": {
"aggregates": [],
"id": "example",
"name": "example"
},
"id": "example",
"quizResults": {
"correctAnswerCount": 1,
"formId": "example",
"questionCount": 1,
"score": 1
},
"timeZone": "example"
},
"consultant": {
"company": {
"businessNumber": "example",
"businessNumberType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"id": "example",
"managedBillingEnabled": false,
"name": "example",
"theme": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {
"defaultCurrency": "example",
"firstName": "example",
"lastName": "example",
"timeZone": "example",
"title": "example"
}
},
"dateCompleted": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"form": {
"aggregates": [],
"id": "example",
"name": "example"
},
"hasAnswers": false,
"id": "example",
"isRecurring": false,
"lastImportDate": "2026-10-01T12:00:00Z",
"review": {
"dateModified": "2026-10-01T12:00:00Z",
"publishStatus": "example",
"questionNotes": [],
"revision": 1,
"summary": "example"
},
"selfSubmit": false,
"started": false
},
"has_more": false,
"next_cursor": null
}Get invoice
Get Invoice.
Inputs
- Alt
alttext - Set to media or pdf to download the invoice as a PDF. Omit to receive JSON.
- Invoice ID
invoice_idtextRequired - The unique identifier of the invoice.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"amountDue": {
"amount": 1,
"currency": "example"
},
"amountPaid": {
"amount": 1,
"currency": "example"
},
"amountPaidOrWrittenOff": {
"amount": 1,
"currency": "example"
},
"amountPayable": {
"amount": 1,
"currency": "example"
},
"amountPendingPayment": {
"amount": 1,
"currency": "example"
},
"amountRefunded": {
"amount": 1,
"currency": "example"
},
"amountWrittenOff": {
"amount": 1,
"currency": "example"
},
"billedTo": "example",
"canProcessPayment": false,
"clientRecord": {
"client": {
"dateCreated": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"profile": {}
},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {
"address": {},
"dateOfBirth": "2026-10-01T12:00:00Z",
"dayOfBirth": "example",
"emailAddress": "example",
"emergencyContacts": [],
"firstName": "example",
"gender": "example",
"genderIdentity": "example",
"healthInsuranceProfile": {},
"healthcareProviders": [],
"homePhone": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"mobilePhone": "example",
"notes": "example",
"occupation": "example",
"patientAccountNumber": "example",
"preferredName": "example",
"pronouns": "example",
"referredBy": "example",
"secondaryContacts": [],
"timeZone": "example",
"title": "example",
"workHoursPerWeek": 1,
"workPhone": "example"
},
"relatedTags": [],
"status": "example"
},
"companyHeader": "example",
"consultant": {
"company": {
"businessNumber": "example",
"businessNumberType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"id": "example",
"managedBillingEnabled": false,
"name": "example",
"theme": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {
"defaultCurrency": "example",
"firstName": "example",
"lastName": "example",
"timeZone": "example",
"title": "example"
}
},
"currency": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"delayedPaymentHistory": [],
"description": "example",
"discount": {
"amount": 1,
"currency": "example"
},
"discountAmount": {
"amount": 1,
"currency": "example"
},
"discountDescription": "example",
"discountPercent": 1,
"hasManagedBilling": false,
"hasRecentFailedDelayedPayment": false,
"id": "example",
"includeSignature": false,
"invoiceDate": "2026-10-01T12:00:00Z",
"invoiceFooter": "example",
"invoiceNumber": "example",
"lineItems": [],
"managedBillingSettings": {
"billingMode": "example",
"companyHeader": "example",
"notificationMode": "example"
},
"minimumPayment": {
"amount": 1,
"currency": "example"
},
"paid": false,
"paymentHistory": [],
"paymentOptions": {
"enabled": false,
"fullPaymentRequired": false,
"id": "example",
"isSubscription": false,
"minimumPaymentAmount": {
"amount": 1,
"currency": "example"
},
"minimumPaymentPercentage": 1,
"name": "example",
"recurrenceOptions": {
"consultantExcludeDates": {},
"count": 1,
"endAfter": {},
"endDate": "2026-10-01T12:00:00Z",
"endDay": "example",
"excludeDates": [],
"leadTime": 1,
"recurrenceRule": "example",
"startAfter": {},
"startDate": "2026-10-01T12:00:00Z",
"timeZone": "example"
},
"recurringCharge": {
"amount": 1,
"currency": "example"
},
"startTime": "example",
"storeBillingInformation": false
},
"paymentStatus": "example",
"publishStatus": "example",
"refundable": false,
"revision": 1,
"subTotal": {
"amount": 1,
"currency": "example"
},
"subTotalBeforeDiscount": {
"amount": 1,
"currency": "example"
},
"tax": {
"amount": 1,
"currency": "example"
},
"taxAmount": {
"amount": 1,
"currency": "example"
},
"taxDescription": "example",
"taxPercent": 1,
"total": {
"amount": 1,
"currency": "example"
},
"writeOffHistory": []
},
"has_more": false,
"next_cursor": null
}Get profile
Get Consultant Profile.
Inputs
- As consultant
as_consultanttext - The ID of the consultant whose profile to retrieve. Omit to return the authenticated consultant's own profile. Requires the settings:read privilege on the target consultant when provided.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"activationStatus": "example",
"company": {
"businessNumber": "example",
"businessNumberType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"id": "example",
"managedBillingEnabled": false,
"name": "example",
"theme": {
"palette": {}
}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"isAssistant": false,
"isOwner": false,
"isPractitioner": false,
"profile": {
"availabilitySettings": {
"afterHoursBookingsDisabled": false,
"currentOutOfOfficePeriod": {},
"externalAllDayEventsIncluded": false,
"externalAvailabilityEnabled": false,
"externalEventBuffer": {},
"isOutOfOffice": false,
"lookBusyDistribution": "example",
"lookBusyFloor": 1,
"lookBusyPercentage": 1,
"magneticBookingSettings": {},
"outOfOfficeSettings": {},
"rollingTimeSlotsEnabled": false,
"sessionLimitSettings": {},
"sessionRequestBuffer": 1,
"sessionRequestThreshold": 1,
"timeSlotRounding": 1
},
"bio": "example",
"bookingSettings": {
"bookingPageRedirectUri": "example",
"bookingsPages": [],
"calendarSlotDuration": 1,
"calendarViewConsultantId": "example",
"cancellationMessage": "example",
"cancellationMessageEnabled": false,
"cancellationPeriod": 1,
"clientBookingChangesSettings": {},
"consultantSessionRemindersEnabled": false,
"eventNameStyle": "example",
"familyRecordBookingEnabled": false,
"hideInternalEventDetails": false,
"hideReferralAndReasonForBooking": false,
"invitationMethods": [],
"jumpToWeekOnDaySelected": false,
"noShowFeeSettings": {},
"oneClickBookingsEnabled": false,
"onlineSessionPhoneRequired": false,
"reminderCalendarColor": 1,
"sessionReminderDeliveryStrategy": "example",
"sessionReminderPeriod": 1,
"sessionReminderSettings": {},
"uninvitedClientSessionConfirmation": false,
"webCalendarView": "example",
"weekCalendarEndTime": "example",
"weekCalendarStartDay": "example",
"weekCalendarStartTime": "example"
},
"claimMdSettings": {
"lastClaimsSyncStartDate": "2026-10-01T12:00:00Z"
},
"clientRecordSettings": {
"autoReviewedJournalEntryTypes": [],
"autoSelectJournals": false,
"dashboardSettings": {},
"disableBarcodeScanner": false,
"disableNutrientClaims": false,
"disableWelcomeVideo": false,
"enableJournalAnalysis": false,
"enableOwnerFiltering": false,
"enableProfileChangeRequests": false,
"folderNameStyle": "example",
"foodJournalOptions": {},
"imperialSettings": {},
"lifestyleJournalOptions": {},
"measurementSystem": "example",
"nameStyle": "example",
"singleInitialAvatars": false,
"welcomeVideoId": "example",
"welcomeVideoType": "example"
},
"dashboardSettings": {
"actions": [],
"dashboards": [],
"subscriptionUsageMetric": "example"
},
"defaultCurrency": "example",
"evexiaSettings": {
"clientId": "example",
"dateSynchronized": "2026-10-01T12:00:00Z",
"includeFhr": false,
"payForClientLabs": false
},
"firstName": "example",
"formSettings": {
"formReminderSettings": {},
"legalName": "example",
"signature": {},
"signatureOrigin": {}
},
"fullscriptSettings": {
"autoCreateTreatmentPlans": false,
"clinicId": "example",
"country": "example",
"dateLabsSynchronized": "2026-10-01T12:00:00Z",
"disableLabs": false,
"displayTemplates": false,
"matchPatientsByEmailAddress": false,
"notifyOnFinalResultsOnly": false,
"practitionerId": "example",
"sendTreatmentEmail": false,
"showRecommendationSuggestions": false
},
"googleCalendarSettings": {
"calendarIds": [],
"hideEventDetails": false,
"includeClientDetails": false,
"includeSessionBufferTime": false,
"syncAvailability": false,
"syncCalendarId": "example",
"syncGroupSessionPlaceholders": false,
"syncInternalEvents": false,
"syncReminders": false,
"syncSessions": false,
"useGoogleInvites": false
},
"healthInsuranceSettings": {
"billingCountry": "example",
"cms1500AcceptAssignment": false,
"cmsServiceFacilityLocationAddress": {},
"cmsServiceFacilityLocationName": "example",
"cmsServiceFacilityNpiNumber": "example",
"cmsServiceFacilityOtherId": "example",
"cmsServiceFacilityOtherIdQualifier": "example",
"defaultClaimColumns": [],
"npiNumber": "example",
"phonePlaceOfServiceCode": {},
"sendSuperbillsAsAttachments": false,
"setBalanceToClientResponsibilityForDeniedClaim": false,
"superbillCompanyHeader": "example",
"superbillTitle": "example",
"taxonomyCode": "example",
"telehealthPlaceOfServiceCode": {},
"useIcd10Codes": false,
"useIcd9Codes": false
},
"invoiceSettings": {
"acceptPayments": false,
"companyHeader": "example",
"defaultCurrency": "example",
"defaultTaxDescription": "example",
"defaultTaxPercent": 1,
"disableCardDeletion": false,
"includeSignature": false,
"invoiceFooter": "example",
"managedBillingSettings": {},
"unpaidInvoiceSettings": {}
},
"lastName": "example",
"messagingSettings": {
"addFaxContactsToShared": false,
"autoSelectLastUpdatedChatSession": false,
"availability": "example",
"chatAutoResponderSettings": {},
"chatMessageCharacterLimit": 1,
"clientNameStyle": "example",
"defaultSharedChatTeamMemberIds": [],
"defaultToBlacklist": false,
"disableDelete": false,
"disableForegroundAlerts": false,
"disableImpromptuVideoSessions": false,
"emailHeaderCaption": "example",
"emailHeaderTitle": "example",
"emailSenderName": "example",
"emailSignature": "example",
"enableForegroundBrowserInstantAlerts": false,
"faxBlacklist": [],
"faxContacts": [],
"faxSenderName": "example",
"groupChatNotifications": [],
"includeFaxCoverSheet": false,
"insecureNotifications": false,
"insecureReminderNotifications": false,
"replyToAddress": "example",
"sendOnEnter": false,
"snoozeSettings": {},
"useLogoInEmailSignature": false,
"useProfilePhotoInEmailHeader": false
},
"naturalDispensarySettings": {
"createClientShoppingCart": false,
"defaultPromoCode": "example",
"practitionerId": "example"
},
"occupation": "example",
"printSettings": {
"displayCompanyNameInHeader": false,
"displayContactInfoInFooter": false,
"displayDocumentIdInFooter": false,
"displaySloganInFooter": false,
"formTemplate": {},
"invoiceTemplate": {},
"logoAlignment": "example",
"logoSize": "example",
"noteTemplate": {},
"printFormat": "example",
"protocolTemplate": {},
"superbillTemplate": {}
},
"professionalDesignationLetters": "example",
"professionalDesignations": [],
"profilePhoto": {
"contentType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"fileSize": 1,
"id": "example",
"name": "example"
},
"protocolSettings": {
"autoAddSupplementsToFavorites": false
},
"rupaSettings": {
"clinicId": "example",
"practitionerId": "example"
},
"shortBio": "example",
"socialNetworkSettings": {
"blogUrl": "example",
"facebookUserName": "example",
"instagramUserName": "example",
"linkedInUserName": "example",
"pinterestUserName": "example",
"skypeUserName": "example",
"tikTokUserName": "example",
"twitterUserName": "example",
"youTubeUserName": "example"
},
"storageSettings": {
"addOnQuota": 1,
"cloudShareDetails": [],
"cloudShares": [],
"lastModified": "2026-10-01T12:00:00Z",
"quota": 1,
"totalQuota": 1,
"usedSpace": 1
},
"telehealthSettings": {
"backgroundEffect": "example",
"backgroundImage": {},
"disableZoomTranscriptionSummarization": false,
"enableRecordingOnStart": false,
"enableTeamMemberRecordingAccess": false,
"launchApplication": "example",
"recordingTranscriptionSummaryCustomTemplateId": "example",
"transcriptionLanguageAutoDetectionEnabled": false,
"transcriptionSummaryStyle": "example"
},
"timeZone": "example",
"title": "example",
"webAnalyticsSettings": {
"facebookPixelId": "example",
"googleAnalyticsId": "example"
},
"wholescriptsSettings": {
"autoCreateRecommendations": false,
"customMedPaxBoxSku": "example",
"practitionerEmail": "example",
"referralCode": "example",
"referralName": "example",
"showRecommendationSuggestions": false
}
}
},
"has_more": false,
"next_cursor": null
}Get program
Get Program.
Inputs
- Course
course_idtextRequired - The unique identifier of the program.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"clientEnrollmentEnabled": false,
"consultant": {
"company": {},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"deliveryMode": "example",
"duration": {
"amount": 1,
"unit": "example"
},
"endDate": "2026-10-01T12:00:00Z",
"ended": false,
"enrollmentCount": 1,
"id": "example",
"isSelfPaced": false,
"lastEnrollmentDate": "2026-10-01T12:00:00Z",
"maximumEnrollments": 1,
"moduleCount": 1,
"moduleGroups": [],
"modules": [],
"name": "example",
"sessionSettings": {
"autoAddEnrollments": false,
"autoConfirmSessionEnrollments": false,
"sendConfirmations": false,
"sendReminders": false
},
"sku": "example",
"startDate": "2026-10-01T12:00:00Z",
"started": false
},
"has_more": false,
"next_cursor": null
}Get session
Get Session.
Inputs
- Record ID
record_idtext - For a group session, the client record ID can be specified to retrieve resources associated with their enrollment.
- Session ID
session_idtextRequired - The unique identifier of the session.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"actualDuration": 1,
"buffer": {
"after": 1,
"before": 1
},
"cancellable": false,
"cancelled": false,
"clientConfirmationStatus": "example",
"clientRecord": {
"client": {
"dateCreated": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"id": "example",
"profile": {}
},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {
"address": {},
"dateOfBirth": "2026-10-01T12:00:00Z",
"dayOfBirth": "example",
"emailAddress": "example",
"emergencyContacts": [],
"firstName": "example",
"gender": "example",
"genderIdentity": "example",
"healthInsuranceProfile": {},
"healthcareProviders": [],
"homePhone": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"mobilePhone": "example",
"notes": "example",
"occupation": "example",
"patientAccountNumber": "example",
"preferredName": "example",
"pronouns": "example",
"referredBy": "example",
"secondaryContacts": [],
"timeZone": "example",
"title": "example",
"workHoursPerWeek": 1,
"workPhone": "example"
},
"relatedTags": [],
"status": "example"
},
"confirmationStatus": "example",
"consultant": {
"company": {
"businessNumber": "example",
"businessNumberType": "example",
"dateCreated": "2026-10-01T12:00:00Z",
"id": "example",
"managedBillingEnabled": false,
"name": "example",
"theme": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {
"defaultCurrency": "example",
"firstName": "example",
"lastName": "example",
"timeZone": "example",
"title": "example"
}
},
"dateConfirmed": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"endDate": "2026-10-01T12:00:00Z",
"fee": {
"amount": 1,
"currency": "example"
},
"hasRecording": false,
"id": "example",
"insurancePoliciesChecked": [],
"internalNotesHistory": [],
"isRecurring": false,
"isSubscription": false,
"location": {
"address": "example",
"clientBookingEnabled": false,
"cmsPlaceOfService": {
"code": "example",
"description": "example"
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"emailAddress": "example",
"faxNumber": "example",
"flexible": false,
"fullAddress": {
"country": "example",
"floor": "example",
"locality": "example",
"postalCode": "example",
"region": "example",
"street": "example",
"unit": "example"
},
"id": "example",
"isDefault": false,
"name": "example",
"notes": "example",
"npiNumber": "example",
"otherId": "example",
"otherIdQualifier": "example",
"phoneNumber": "example",
"room": "example",
"suggested": false,
"website": "example"
},
"notes": "example",
"notesHistory": [],
"paymentStatus": "example",
"service": {
"consultant": {
"company": {},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {}
},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"id": "example",
"isGroupService": false,
"name": "example",
"serviceTypes": [],
"sku": "example"
},
"serviceType": "example",
"sessionDate": "2026-10-01T12:00:00Z",
"sessionNotes": {
"artifacts": [],
"booking": {
"actualDuration": 1,
"buffer": {},
"cancellable": false,
"cancelled": false,
"confirmationStatus": "example",
"consultant": {},
"dateConfirmed": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"duration": 1,
"endDate": "2026-10-01T12:00:00Z",
"fee": {},
"hasRecording": false,
"id": "example",
"insurancePoliciesChecked": [],
"internalNotesHistory": [],
"isRecurring": false,
"isSubscription": false,
"location": {},
"notes": "example",
"notesHistory": [],
"paymentStatus": "example",
"service": {},
"serviceType": "example",
"sessionDate": "2026-10-01T12:00:00Z",
"sessionNotes": {},
"timeZone": "example",
"upcoming": false
},
"clientRecord": {
"client": {},
"dateActivated": "2026-10-01T12:00:00Z",
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"invitationSent": false,
"isActive": false,
"isChildRecord": false,
"lastActivityDate": "2026-10-01T12:00:00Z",
"parentRecord": {},
"profile": {},
"relatedTags": [],
"status": "example"
},
"completionStatus": "example",
"consultant": {
"company": {},
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"id": "example",
"isOwner": false,
"isPractitioner": false,
"profile": {}
},
"content": [],
"dateCreated": "2026-10-01T12:00:00Z",
"dateModified": "2026-10-01T12:00:00Z",
"datePrepared": "2026-10-01T12:00:00Z",
"diagnosisCodes": [],
"diagnosisCodesPublishStatus": "example",
"hasCosignReminder": false,
"id": "example",
"isArchived": false,
"isCosigned": false,
"labRequests": [],
"name": "example",
"notes": "example",
"procedureCodes": [],
"procedureCodesPublishStatus": "example",
"protocols": [],
"publishStatus": "example",
"reminders": [],
"revision": 1,
"sessionDate": "2026-10-01T12:00:00Z",
"summary": "example"
},
"timeZone": "example",
"upcoming": false
},
"has_more": false,
"next_cursor": null
}List client packages
List Client Packages.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Consultants
consultantslist - The IDs of the consultants whose client packages should be retrieved.
- Expired
expiredtrue/false - If true, will return only expired packages. If false, will return active packages. If omitted, will return both.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Packages
packageslist - Filter for client packages associated with these base package IDs.
- Records
recordslist - The IDs of the client records whose client packages should be retrieved.
- Status
statuslist - The statuses fo the client packages to retrieve. Possible values are pending confirmed cancelled.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List clients
List Client Records.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Child
childtrue/false - If true, will return only sub-records. If false, will return only primary client records. If omitted, will return both. [Learn more](https://help.practicebetter.io/hc/en-us/articles/115007154147)
- Record client
record_clienttrue/false - If true only return client records that have an active Practice Better user account linked.
- Details
detailstrue/false - If true, will return addresses, contacts, insurance information and other details.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Modified eq
modified_eqdate and time - Modified eq for this request.
- Modified gte
modified_gtedate and time - Modified gte for this request.
- Modified lte
modified_ltedate and time - Modified lte for this request.
- Status
statuslist - A list of client statuses. Possible values are pendingcreate created. A pendingcreate record is a prospective client that does not count towards your subscription limit. A prospective record turns into a created client once you've added them to your account either manually or via an automation. [Learn more](https://help.practicebetter.io/hc/en-us/articles/360026475051)
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List form requests
List Form Requests.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Completed
completedtrue/false - If true return requests completed by the client. If false return only incomplete requests. If omitted, return both.
- Consultants
consultantslist - The IDs of the consultants whose form requests should be retrieved.
- Created eq
created_eqdate and time - Created eq for this request.
- Created gte
created_gtedate and time - Created gte for this request.
- Created lte
created_ltedate and time - Created lte for this request.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Records
recordslist - The IDs of the client records whose form requests should be retrieved.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List forms
List Forms.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Team for
team_fortext - Filter resources by team ownership. Values: 'all' (all team members), 'self' (authenticated user only), 'other' (other team members excluding self), 'in' (specific subset via team_ids). Defaults to 'self or shared' when not specified.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List invoices
List Invoices.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Consultants
consultantslist - The IDs of the consultants whose invoices should be retrieved.
- Invoicedate eq
invoicedate_eqdate and time - Invoicedate eq for this request.
- Invoicedate gte
invoicedate_gtedate and time - Invoicedate gte for this request.
- Invoicedate lte
invoicedate_ltedate and time - Invoicedate lte for this request.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Paymentstatus
paymentstatuslist - The payment statuses of the invoices to retrieve. Possible values are unpaid partial paid.
- Records
recordslist - The IDs of the client records whose invoices should be retrieved.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List packages
List Package Definitions.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List programs
List Programs.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Consultants
consultantslist - The IDs of the consultants whose programs should be retrieved.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Team for
team_fortext - Filter resources by team ownership. Values: 'all' (all team members), 'self' (authenticated user only), 'other' (other team members excluding self), 'in' (specific subset via team_ids). Defaults to 'self or shared' when not specified.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List services
List Services.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Team for
team_fortext - Filter resources by team ownership. Values: 'all' (all team members), 'self' (authenticated user only), 'other' (other team members excluding self), 'in' (specific subset via team_ids). Defaults to 'self or shared' when not specified.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List sessions
List Sessions.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Consultants
consultantslist - The IDs of the consultants whose sessions should be retrieved.
- Date eq
date_eqdate and time - Date eq for this request.
- Date gte
date_gtedate and time - Date gte for this request.
- Date lte
date_ltedate and time - Date lte for this request.
- Group
grouptrue/false - If true, will return group sessions. If false, will return 1-1 sessions. If omitted, will return both.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Records
recordslist - The IDs of the client records whose sessions should be retrieved.
- Record services
record_serviceslist - Retrieve sessions associated with these service IDs.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List tags
List Tags.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List tasks
List Tasks.
Inputs
- After ID
after_idtext - Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
- Before ID
before_idtext - Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
- Completed
completedtrue/false - If true return completed tasks. If false return only pending tasks. If omitted, return both.
- Consultants
consultantslist - The IDs of the consultants whose tasks should be retrieved.
- Limit
limitnumber - A limit on the number of objects to return between 1 and 100.From 1 to 100.
- Records
recordslist - The IDs of the client records whose tasks should be retrieved.
- Team for
team_fortext - Filter resources by team ownership. Values: 'all' (all team members), 'self' (authenticated user only), 'other' (other team members excluding self), 'in' (specific subset via team_ids). Defaults to 'self or shared' when not specified.
- Type
typelist - The task type, i.e. personal task or client task. Possible values are consultant client.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List webhook deliveries
List deliveries.
Inputs
- End date
end_datedate and time - Filter deliveries attempted on or before this UTC date/time. Omit for no upper bound.
- Event type
event_typetext - Filter to deliveries for this event type. Omit to return deliveries regardless of event type.
- Max attempts
max_attemptsnumber - Filter to deliveries with at most this many attempts. Omit for no maximum.
- Min attempts
min_attemptsnumber - Filter to deliveries with at least this many attempts. Omit for no minimum.
- Page
pagenumber - The 1-based page number to return. Defaults to 1.At least 1.
- Page size
page_sizenumber - The number of deliveries to return per page. Defaults to 25.From 1 to 100.
- Start date
start_datedate and time - Filter deliveries attempted on or after this UTC date/time. Omit for no lower bound.
- Status
statustext - Filter by delivery status. Possible values are Pending InProgress Succeeded Failed DeadLetterQueue Cancelled. Omit to return deliveries in any status.One of:
Pending,InProgress,Succeeded,Failed,DeadLetterQueue,Cancelled. - Subscription ID
subscription_idtext - Filter to deliveries for this webhook subscription. Omit to return deliveries across all of the company's subscriptions.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}List webhook event types
List available event types.
Inputs
None.
Outputs
Value.
datalist- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}List webhook subscriptions
List subscriptions.
Inputs
- Event type
event_typetext - Filter to subscriptions subscribed to this event type. Omit to return subscriptions regardless of event type.
- Is active
is_activetrue/false - If true, return only active subscriptions. If false, return only inactive subscriptions. If omitted, return both.
- Status
statustext - Filter by subscription status. Possible values are PendingVerification Active Disabled VerificationFailed EndpointGone. Omit to return subscriptions in any status.One of:
PendingVerification,Active,Disabled,VerificationFailed,EndpointGone.
Outputs
Value.
dataobject- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": {
"count": 1,
"hasMore": false,
"items": []
},
"has_more": false,
"next_cursor": null
}Send forms
Create Form Requests.
Inputs
- As consultant ID
as_consultant_idtext - The ID of the consultant assigned to the form requests. Null if not set.
- Client record ID
client_record_idtext - The ID of the client that should be sent the form requests. (Note: clientRecordId and clientRecordIds are mutually exclusive - use one or the other)
- Client record IDs
client_record_idslist - The IDs of the client records that should be sent the form requests. (Note: clientRecordId and clientRecordIds are mutually exclusive - use one or the other)
- Client records
client_recordsobject - Client records for this request.
- Form IDs
form_idslistRequired - A list of form IDs for the client to complete.
- Notes
notestext - Notes for this request.
- Package instance ID
package_instance_idtext - Optionally link this request to a package instance. (not valid for batch operation using clientRecordIds) Null if not set.
- Send nutri q
send_nutri_qtrue/false - True to send the NTA NAQ form to the client (via [Nutritional Therapy Association Integration])). False or null to skip.
- Send nutri qv2
send_nutri_qv2true/false - True to send the NTA NAQ V2 form to the client (via [Nutritional Therapy Association Integration])). False or null to skip.
- Send wellness questionnaire
send_wellness_questionnairetrue/false - True to send the Wellness Questionnaire form to the client (via [Whole Practice Integration](https://help.practicebetter.io/hc/en-us/articles/360056998212)). False or null to skip.
- Session ID
session_idtext - Optionally link the form requests to a session (one-on-one) when using clientRecordId or to a group session when sending in batch using clientRecordIds. Null if not set.
Outputs
Value.
datanull- Response from the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Next page cursor; empty when there are no more pages.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}