Practice Better

App · 25 actions

Connect Practice Better to manage your account records and automate everyday work.

Actions

ActionWhat it does
Book sessionBook a Session.
Cancel sessionCancel a Session.
Create clientCreate Client Record.
Get available slotsGet Availability Slots.
Get clientGet Client Record.
Get form requestGet Form Request.
Get invoiceGet Invoice.
Get profileGet Consultant Profile.
Get programGet Program.
Get sessionGet Session.
List client packagesList Client Packages.
List clientsList Client Records.
List form requestsList Form Requests.
List formsList Forms.
List invoicesList Invoices.
List packagesList Package Definitions.
List programsList Programs.
List servicesList Services.
List sessionsList Sessions.
List tagsList Tags.
List tasksList Tasks.
List webhook deliveriesList deliveries.
List webhook event typesList available event types.
List webhook subscriptionsList subscriptions.
Send formsCreate Form Requests.

Book session

Book a Session.

Inputs

As consultant IDas_consultant_idtext
The ID of the consultant assigned to the client's session.
Bufferbufferobject
Buffer for this request.
Client record IDclient_record_idtextRequired
The unique identifier of the client record.
Durationdurationnumber
The duration of the session in seconds, e.g. 900 for a 15 minute session. If omitted, defaults to the duration of the service.
Feefeeobject
Fee for this request.
Ignore conflictignore_conflicttrue/false
If true, will book session despite potential conflicts in practitioner's calendar.
Locationlocationobject
Location for this request.
Mark confirmedmark_confirmedtrue/false
Mark session as client-confirmed, avoids seeing "Confirm" button in email.
Notesnotestext
Notes for this request.
Notification optionsnotification_optionsobject
Notification options for this request.
Notifynotifytrue/false
If false, will not send a confirmation notification to the client.
Serviceservice_idtextRequired
The unique identifier of the service.
Service typeservice_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 datesession_datedate and timeRequired
The date and time of the session.
Telehealth settingstelehealth_settingsobject
Telehealth settings for this request.
Time zonetime_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 IDsession_idtextRequired
The unique session Identifier
Cancel pending bookingscancel_pending_bookingstrue/false
If true, cancels upcoming sessions and session requests that have not been accepted.
Cancel recurring automationscancel_recurring_automationstrue/false
If true, cancels any active payment plans associated with the client's package.
Notesnotestext
An optional note to include in the cancellation notification.
Notifynotifytrue/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 folderdocuments_foldertrue/false
Create a documents folder for the client.
Food journal optionsfood_journal_optionsobject
Food journal options for this request.
Food mood journalfood_mood_journaltrue/false
Give the client access to the Food & Mood Journal.
Form IDsform_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 activeis_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 journallifestyle_journaltrue/false
Give the client access to the Lifestyle Journal.
Lifestyle journal optionslifestyle_journal_optionsobject
Lifestyle journal options for this request.
Parent record IDparent_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)
Addressaddressobject
Address for this request.
Date of birthdate_of_birthdate
This is a legacy field. Use dayOfBirth instead. Null if not set.
Day of birthday_of_birthtext
Day of birth for this request.
Email addressemail_addresstextRequired
The email address of this client.
Emergency contactsemergency_contactslist
The list of emergency contacts for this client. Null or empty if none are set.
First namefirst_nametextRequired
The first name of this client.
Gendergendertext
This is a legacy field. Use genderIdentity instead. Null if not set.
Gender IDentitygender_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 providershealthcare_providerslist
The list of referring or treating healthcare providers for this client. Null or empty if none are set.
Health insurance profilehealth_insurance_profileobject
Health insurance profile for this request.
Home phonehome_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 namelast_nametextRequired
The last name of this client.
Marital statusmarital_statustext
The client's marital status. Possible values are single commonlaw married partnered separated divorced widowed. Null if not set.
Middle namemiddle_nametext
The middle name of this client. Null if not set.
Mobile phonemobile_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)
Notesnotestext
Free-text internal notes about this client, not visible to the client. Null if not set.
Occupationoccupationtext
The occupation of this client. Null if not set.
Patient account numberpatient_account_numbertext
A patient/client identifier used to populate line 26 of the CMS 1500 form. Null if not set.
Preferred namepreferred_nametext
The preferred name or nickname of this client. Null if not set.
Pronounspronounstext
The client's pronouns. Possible values are He/Him She/Her They/Them No Pronouns, or a custom value. Null if not set.
Referred byreferred_bytext
The source this client was referred from. Null if not set.
Secondary contactssecondary_contactslist
The list of secondary (non-emergency) contacts for this client. Null or empty if none are set.
Time zonetime_zonetext
The time zone of this client, using Windows Standard time zone names (e.g. Eastern Standard Time). Null if not set.
Titletitletext
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 weekwork_hours_per_weeknumber
The number of hours this client works per week. Null if not set.
Work phonework_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 invitationsend_invitationtrue/false
Send an email invitation to the client to join Practice Better.
Send nutri qsend_nutri_qtrue/false
Flag to send the NTA NAQ form to the client (via [Nutritional Therapy Association Integration]))
Send nutri qv2send_nutri_qv2true/false
Flag to send the NTA NAQ V2 form to the client (via [Nutritional Therapy Association Integration]))
Send wellness questionnairesend_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 actionstag_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 consultantas_consultanttextRequired
The ID of the consultant.
Daydaydate and timeRequired
The start date for checking the availability. The API will return availability slots beginning on this date spanning 31 days.
Locationlocationtext
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)
Packagepackagetext
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)
Serviceservice_idtextRequired
The unique identifier of the service. The availability slots are based on the service.
Typetypetext
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 IDrecord_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

Altalttext
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.
Notesnotestrue/false
Include form notes in the form request.
Request IDrequest_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

Altalttext
Set to media or pdf to download the invoice as a PDF. Omit to receive JSON.
Invoice IDinvoice_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 consultantas_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

Coursecourse_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 IDrecord_idtext
For a group session, the client record ID can be specified to retrieve resources associated with their enrollment.
Session IDsession_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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Consultantsconsultantslist
The IDs of the consultants whose client packages should be retrieved.
Expiredexpiredtrue/false
If true, will return only expired packages. If false, will return active packages. If omitted, will return both.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Packagespackageslist
Filter for client packages associated with these base package IDs.
Recordsrecordslist
The IDs of the client records whose client packages should be retrieved.
Statusstatuslist
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Childchildtrue/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 clientrecord_clienttrue/false
If true only return client records that have an active Practice Better user account linked.
Detailsdetailstrue/false
If true, will return addresses, contacts, insurance information and other details.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Modified eqmodified_eqdate and time
Modified eq for this request.
Modified gtemodified_gtedate and time
Modified gte for this request.
Modified ltemodified_ltedate and time
Modified lte for this request.
Statusstatuslist
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Completedcompletedtrue/false
If true return requests completed by the client. If false return only incomplete requests. If omitted, return both.
Consultantsconsultantslist
The IDs of the consultants whose form requests should be retrieved.
Created eqcreated_eqdate and time
Created eq for this request.
Created gtecreated_gtedate and time
Created gte for this request.
Created ltecreated_ltedate and time
Created lte for this request.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Recordsrecordslist
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Team forteam_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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Consultantsconsultantslist
The IDs of the consultants whose invoices should be retrieved.
Invoicedate eqinvoicedate_eqdate and time
Invoicedate eq for this request.
Invoicedate gteinvoicedate_gtedate and time
Invoicedate gte for this request.
Invoicedate lteinvoicedate_ltedate and time
Invoicedate lte for this request.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Paymentstatuspaymentstatuslist
The payment statuses of the invoices to retrieve. Possible values are unpaid partial paid.
Recordsrecordslist
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Limitlimitnumber
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Consultantsconsultantslist
The IDs of the consultants whose programs should be retrieved.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Team forteam_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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Team forteam_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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Consultantsconsultantslist
The IDs of the consultants whose sessions should be retrieved.
Date eqdate_eqdate and time
Date eq for this request.
Date gtedate_gtedate and time
Date gte for this request.
Date ltedate_ltedate and time
Date lte for this request.
Groupgrouptrue/false
If true, will return group sessions. If false, will return 1-1 sessions. If omitted, will return both.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Recordsrecordslist
The IDs of the client records whose sessions should be retrieved.
Record servicesrecord_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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Limitlimitnumber
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 IDafter_idtext
Return objects that come after this ID. Use this to fetch more objects if the list is sorted in ascending order.
Before IDbefore_idtext
Return objects that come before this ID. Use this to fetch more objects if the list is sorted in descending order.
Completedcompletedtrue/false
If true return completed tasks. If false return only pending tasks. If omitted, return both.
Consultantsconsultantslist
The IDs of the consultants whose tasks should be retrieved.
Limitlimitnumber
A limit on the number of objects to return between 1 and 100.From 1 to 100.
Recordsrecordslist
The IDs of the client records whose tasks should be retrieved.
Team forteam_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.
Typetypelist
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 dateend_datedate and time
Filter deliveries attempted on or before this UTC date/time. Omit for no upper bound.
Event typeevent_typetext
Filter to deliveries for this event type. Omit to return deliveries regardless of event type.
Max attemptsmax_attemptsnumber
Filter to deliveries with at most this many attempts. Omit for no maximum.
Min attemptsmin_attemptsnumber
Filter to deliveries with at least this many attempts. Omit for no minimum.
Pagepagenumber
The 1-based page number to return. Defaults to 1.At least 1.
Page sizepage_sizenumber
The number of deliveries to return per page. Defaults to 25.From 1 to 100.
Start datestart_datedate and time
Filter deliveries attempted on or after this UTC date/time. Omit for no lower bound.
Statusstatustext
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 IDsubscription_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 typeevent_typetext
Filter to subscriptions subscribed to this event type. Omit to return subscriptions regardless of event type.
Is activeis_activetrue/false
If true, return only active subscriptions. If false, return only inactive subscriptions. If omitted, return both.
Statusstatustext
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 IDas_consultant_idtext
The ID of the consultant assigned to the form requests. Null if not set.
Client record IDclient_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 IDsclient_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 recordsclient_recordsobject
Client records for this request.
Form IDsform_idslistRequired
A list of form IDs for the client to complete.
Notesnotestext
Notes for this request.
Package instance IDpackage_instance_idtext
Optionally link this request to a package instance. (not valid for batch operation using clientRecordIds) Null if not set.
Send nutri qsend_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 qv2send_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 questionnairesend_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 IDsession_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
}

On this page