Healthie

App · 25 actions

Run your Healthie practice from workflows: add and update clients, book, reschedule and cancel appointments, find open times, send forms and messages, tag clients, add documents and goals, and send invoices. Start a workflow when a client is added, an appointment is booked, moved or cancelled, a form is completed, a chart note is signed, a message arrives or an invoice is paid.

Actions

ActionWhat it does
Add tags to clientPut tags on a client.
Archive clientArchive a client, Healthie's way to retire one: their record and history stay, and they can be restored in Healthie.
Cancel appointmentMark an appointment as cancelled.
Create appointmentBook a one-to-one appointment for a client, as a provider would.
Create clientAdd a client (patient) to Healthie.
Create goalSet a goal for a client, such as walking 20 minutes a day, which they track in their Healthie app.
Create invoiceBill a client for a service.
Delete recordDelete an appointment, document, goal, tag, invoice or form request for good.
Find clientsSearch clients by name, email, phone, date of birth or record number, or list them by status, group, provider or tag.
Find open timesFind when a provider can be booked for an appointment type, up to 7 days at a time.
Get appointmentGet an appointment's details: when, with whom, its type, how it happens and its status.
Get clientGet a client's details: contact details, date of birth, provider, group, tags and next appointment.
Get completed formGet a completed form or chart note with every question and its answer.
List appointment typesList the kinds of appointment your account offers, with their length and the ways each can happen, such as Healthie Video Call or In Person.
List appointmentsList your organization's appointments, upcoming ones soonest first and past ones latest first, for a client, provider, type, status or days.
List completed formsList completed forms and chart notes with their answers, newest first: a client's, one form's, or everyone's, signed or not.
List documentsList documents, newest first: those in a client's chart, or your own.
List formsList your account's forms, such as intake forms and chart note templates.
List invoicesList invoices, newest first: everyone's or one client's, paid or not.
Remove tags from clientTake tags off a client.
Send form to clientAsk a client to fill in a form in their Healthie portal, such as an intake form or a consent.
Send messageSend a chat message in Healthie, to a client or a conversation.
Update appointmentReschedule an appointment, or change its type, provider, how it happens, status or notes.
Update clientChange a client's details.
Upload documentAdd a document to a client's chart, from a file or from text you give (saved as a text file).

Add tags to client

Put tags on a client. A tag name the account doesn't have yet is created.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
TagstagslistRequired
The tags to add: pick them, or type new names.

Outputs

client_idtext
The client's ID
countnumber
How many
tagslist
The tags
Example output
{
  "client_id": "312045",
  "count": 1,
  "tags": [
    {
      "id": "5520",
      "name": "New client"
    }
  ]
}

Archive client

Archive a client, Healthie's way to retire one: their record and history stay, and they can be restored in Healthie. Healthie doesn't delete clients.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.

Outputs

activetrue/false
False once the client is archived
citytext
Their city
countrytext
Their country code
created_attext
When they were added (ISO 8601)
date_of_birthtext
Their date of birth (YYYY-MM-DD)
emailtext
Their email
first_nametext
Their first (preferred) name
gendertext
Their gender, as entered in Healthie
group_idtext
Their client group's ID; empty if none
group_nametext
Their client group's name
idtext
The client's Healthie ID
last_nametext
Their last name
legal_nametext
Their legal first name, if it differs
nametext
Their full name
next_appointmenttext
When their next appointment starts (ISO 8601)
phonetext
Their phone number
provider_idtext
Their primary provider's ID
provider_nametext
Their primary provider's name
quick_notestext
The quick notes providers keep on them
record_identifiertext
Their record identifier (medical record number)
statetext
Their state
streettext
Their street address
tag_idslist
The IDs of the tags on them
tagslist
The names of the tags on them
timezonetext
Their time zone, such as America/New_York
updated_attext
When their record last changed (ISO 8601)
ziptext
Their ZIP or postcode
Example output
{
  "active": false,
  "city": "",
  "country": "",
  "created_at": "2026-11-05T14:02:11+00:00",
  "date_of_birth": "1990-01-01",
  "email": "test.patient@example.com",
  "first_name": "Test",
  "gender": "Female",
  "group_id": "",
  "group_name": "",
  "id": "312045",
  "last_name": "Patient",
  "legal_name": "",
  "name": "Test Patient",
  "next_appointment": "2026-11-12T15:00:00+00:00",
  "phone": "555-010-0123",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "quick_notes": "",
  "record_identifier": "",
  "state": "",
  "street": "",
  "tag_ids": [
    "5520"
  ],
  "tags": [
    "New client"
  ],
  "timezone": "America/New_York",
  "updated_at": "2026-11-05T14:02:11+00:00",
  "zip": ""
}

Cancel appointment

Mark an appointment as cancelled. It stays on the calendar and in reports, as Healthie recommends, and Healthie emails the client and provider.

Inputs

AppointmentappointmenttextRequired
The appointment's Healthie ID, from another Healthie step or the trigger.
Late cancellationlatetrue/false
Mark it as a late cancellation, if your account uses that status. If your account bills late cancellations, this can charge the client.Default: false.
Cancelled bycancelled_bytext
Who called it off.One of: client (The client), provider (The provider), organization (The organization).
Reasonreasontext
Why it was cancelled.

Outputs

appointment_type_idtext
Its appointment type's ID
appointment_type_nametext
Its appointment type's name
attendee_idslist
The IDs of everyone attending
client_confirmedtrue/false
False while the client still has to confirm it
client_emailtext
The client's email
client_idtext
The client's ID; empty for a group appointment
client_nametext
The client's name
confirmedtrue/false
True once the provider confirmed it
contact_typetext
How it happens, such as Healthie Video Call or In Person
created_attext
When it was booked (ISO 8601)
idtext
The appointment's Healthie ID
is_grouptrue/false
True for a group appointment
length_minutesnumber
How long it is, in minutes
locationtext
Where it is, for an in-person appointment
notestext
The provider's notes on it, which clients don't see
provider_idtext
The provider's ID
provider_nametext
The provider's name
starttext
When it starts (ISO 8601)
statustext
Its status: Occurred, No-Show, Re-Scheduled, Cancelled, Late Cancellation or Checked-In; empty if none is set
status_changed_attext
When its status last changed (ISO 8601)
updated_attext
When it last changed (ISO 8601)
video_urltext
Its own video link, if one was set
Example output
{
  "appointment_type_id": "4021",
  "appointment_type_name": "Initial Consultation",
  "attendee_ids": [
    "312045"
  ],
  "client_confirmed": true,
  "client_email": "test.patient@example.com",
  "client_id": "312045",
  "client_name": "Test Patient",
  "confirmed": true,
  "contact_type": "Healthie Video Call",
  "created_at": "2026-11-05T14:10:00+00:00",
  "id": "880413",
  "is_group": false,
  "length_minutes": 60,
  "location": "",
  "notes": "",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "start": "2026-11-12T15:00:00+00:00",
  "status": "Cancelled",
  "status_changed_at": "",
  "updated_at": "2026-11-05T14:10:00+00:00",
  "video_url": ""
}

Create appointment

Book a one-to-one appointment for a client, as a provider would. Healthie books it even outside open times unless you turn on Only at an open time, and emails the client as your settings say.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
Appointment typeappointment_typetextRequired
What kind of appointment it is.
Startstartdate and timeRequired
When it starts.
Contact typecontact_typetextRequired
How it happens, such as Healthie Video Call or In Person.
Providerprovidertext
Who it is with. Defaults to you.
Locationlocationtext
Where it is, for an in-person visit.
Video linkvideo_urltext
A video call link to use instead of Healthie's own video.
Notesnotestext
Notes on it that only providers see.
Only at an open timeonly_if_opentrue/false
Refuse to book it unless the provider is free then.Default: false.

Outputs

appointment_type_idtext
Its appointment type's ID
appointment_type_nametext
Its appointment type's name
attendee_idslist
The IDs of everyone attending
client_confirmedtrue/false
False while the client still has to confirm it
client_emailtext
The client's email
client_idtext
The client's ID; empty for a group appointment
client_nametext
The client's name
confirmedtrue/false
True once the provider confirmed it
contact_typetext
How it happens, such as Healthie Video Call or In Person
created_attext
When it was booked (ISO 8601)
idtext
The appointment's Healthie ID
is_grouptrue/false
True for a group appointment
length_minutesnumber
How long it is, in minutes
locationtext
Where it is, for an in-person appointment
notestext
The provider's notes on it, which clients don't see
provider_idtext
The provider's ID
provider_nametext
The provider's name
starttext
When it starts (ISO 8601)
statustext
Its status: Occurred, No-Show, Re-Scheduled, Cancelled, Late Cancellation or Checked-In; empty if none is set
status_changed_attext
When its status last changed (ISO 8601)
updated_attext
When it last changed (ISO 8601)
video_urltext
Its own video link, if one was set
Example output
{
  "appointment_type_id": "4021",
  "appointment_type_name": "Initial Consultation",
  "attendee_ids": [
    "312045"
  ],
  "client_confirmed": true,
  "client_email": "test.patient@example.com",
  "client_id": "312045",
  "client_name": "Test Patient",
  "confirmed": true,
  "contact_type": "Healthie Video Call",
  "created_at": "2026-11-05T14:10:00+00:00",
  "id": "880413",
  "is_group": false,
  "length_minutes": 60,
  "location": "",
  "notes": "",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "start": "2026-11-12T15:00:00+00:00",
  "status": "",
  "status_changed_at": "",
  "updated_at": "2026-11-05T14:10:00+00:00",
  "video_url": ""
}

Create client

Add a client (patient) to Healthie. Healthie's welcome email, which invites them to set a password, is sent only if you turn on Send welcome email.

Inputs

First namefirst_nametextRequired
Their first name.
Last namelast_nametextRequired
Their last name.
Emailemailtext
Their email.
Phonephonetext
Their phone number, such as +1 415 555 0134.
Date of birthdate_of_birthdate
Their date of birth.
Gendergendertext
Their gender, such as Female.
Providerprovidertext
Their primary provider. Defaults to you.
Client groupclient_grouptext
The client group they belong to.
Time zonetimezonetext
Their time zone, such as America/New_York.
Send welcome emailsend_welcome_emailtrue/false
Email them Healthie's invitation to set a password and sign in.Default: false.

Outputs

activetrue/false
False once the client is archived
citytext
Their city
countrytext
Their country code
created_attext
When they were added (ISO 8601)
date_of_birthtext
Their date of birth (YYYY-MM-DD)
emailtext
Their email
first_nametext
Their first (preferred) name
gendertext
Their gender, as entered in Healthie
group_idtext
Their client group's ID; empty if none
group_nametext
Their client group's name
idtext
The client's Healthie ID
last_nametext
Their last name
legal_nametext
Their legal first name, if it differs
nametext
Their full name
next_appointmenttext
When their next appointment starts (ISO 8601)
phonetext
Their phone number
provider_idtext
Their primary provider's ID
provider_nametext
Their primary provider's name
quick_notestext
The quick notes providers keep on them
record_identifiertext
Their record identifier (medical record number)
statetext
Their state
streettext
Their street address
tag_idslist
The IDs of the tags on them
tagslist
The names of the tags on them
timezonetext
Their time zone, such as America/New_York
updated_attext
When their record last changed (ISO 8601)
ziptext
Their ZIP or postcode
Example output
{
  "active": true,
  "city": "",
  "country": "",
  "created_at": "2026-11-05T14:02:11+00:00",
  "date_of_birth": "1990-01-01",
  "email": "test.patient@example.com",
  "first_name": "Test",
  "gender": "Female",
  "group_id": "",
  "group_name": "",
  "id": "312045",
  "last_name": "Patient",
  "legal_name": "",
  "name": "Test Patient",
  "next_appointment": "2026-11-12T15:00:00+00:00",
  "phone": "555-010-0123",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "quick_notes": "",
  "record_identifier": "",
  "state": "",
  "street": "",
  "tag_ids": [
    "5520"
  ],
  "tags": [
    "New client"
  ],
  "timezone": "America/New_York",
  "updated_at": "2026-11-05T14:02:11+00:00",
  "zip": ""
}

Create goal

Set a goal for a client, such as walking 20 minutes a day, which they track in their Healthie app.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
GoalnametextRequired
What the goal is.
Repeatrepeattext
How often they work on it. Defaults to daily.One of: Daily, Weekly, Once. Default: Daily.
Startstart_datedate
When it starts.
Enddue_datedate
When it ends. Leave blank for open-ended.
Detailsdescriptiontext
More about it.

Outputs

client_idtext
The client it is for
created_attext
When it was set (ISO 8601)
descriptiontext
More about it
due_datetext
When it ends (YYYY-MM-DD); empty if open-ended
idtext
The goal's ID
nametext
What the goal is
repeattext
How often: Daily, Weekly or Once
start_datetext
When it starts (YYYY-MM-DD)
Example output
{
  "client_id": "312045",
  "created_at": "2026-11-05T15:45:00+00:00",
  "description": "",
  "due_date": "2026-12-06",
  "id": "66120",
  "name": "Walk 20 minutes",
  "repeat": "Daily",
  "start_date": "2026-11-06"
}

Create invoice

Bill a client for a service. The invoice appears in their Healthie portal for them to pay, and Healthie may email it to them.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
AmountamountnumberRequired
How much it is for, such as 150.At least 0.01.
FordescriptiontextRequired
What it is for, such as Follow-up session.
Notesnotestext
Extra details on the invoice, which the client sees.
Date of serviceservice_datedate
When the service was given.
Providerprovidertext
Who it is from. Defaults to you.

Outputs

amountnumber
How much it is for
balance_duenumber
How much is still to pay
client_idtext
The client billed
client_nametext
Their name
created_attext
When it was made (ISO 8601)
currencytext
Its currency, such as USD
descriptiontext
What it is for, in words
idtext
The invoice's ID
invoice_numbertext
Its invoice number, as the client sees it
notestext
The extra details the client sees on it
paid_attext
When it was paid (ISO 8601); empty if not yet
provider_idtext
The provider it is from
provider_nametext
Their name
service_datetext
The date of service (ISO 8601)
statustext
Paid, Not Yet Paid or Partial
typetext
What it is for: other, offering (a package) or cms1500
Example output
{
  "amount": 150.0,
  "balance_due": 150.0,
  "client_id": "312045",
  "client_name": "Test Patient",
  "created_at": "2026-11-05T16:00:00+00:00",
  "currency": "USD",
  "description": "Other: Follow-up session",
  "id": "45120",
  "invoice_number": "UU-1-2026",
  "notes": "",
  "paid_at": "",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "service_date": "2026-11-05T00:00:00+00:00",
  "status": "Not Yet Paid",
  "type": "other"
}

Delete record

Delete an appointment, document, goal, tag, invoice or form request for good. To call off an appointment, use 'Cancel appointment' instead so it stays in your reports. Deleting a tag takes it off every client.

Inputs

Typerecord_typetextRequired
What kind of record it is.One of: appointment, document, goal, tag, invoice, form_request (Form request).
RecordrecordtextRequired
The record's ID, from another Healthie step or the trigger.
Email the attendeesemail_attendeestrue/false
For an appointment: send Healthie's cancellation email.Only when Type is Appointment. Default: false.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
record_typetext
appointment, document, goal, tag, invoice or form_request: what was deleted
Example output
{
  "deleted": true,
  "id": "880413",
  "record_type": "appointment"
}

Find clients

Search clients by name, email, phone, date of birth or record number, or list them by status, group, provider or tag. Leave every field blank to list them all.

Inputs

Searchsearchtext
Words to look for, such as a name, an email or a date of birth.
Statusstatustext
Only active or only archived clients. Leave blank for both.One of: active, archived.
Client groupclient_grouptext
The client group they belong to.
Providerprovidertext
Only clients of this provider.
Tagstagslist
Only clients with at least one of these tags.
Sort bysorttext
How to order them. Defaults to last name.One of: LAST_NAME_ASC (Last name), CREATED_AT_DESC (Newest first), UPDATED_AT_DESC (Recently changed). Default: LAST_NAME_ASC.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

clientslist
The clients found
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "clients": [
    {
      "active": true,
      "city": "",
      "country": "",
      "created_at": "2026-11-05T14:02:11+00:00",
      "date_of_birth": "1990-01-01",
      "email": "test.patient@example.com",
      "first_name": "Test",
      "gender": "Female",
      "group_id": "",
      "group_name": "",
      "id": "312045",
      "last_name": "Patient",
      "legal_name": "",
      "name": "Test Patient",
      "next_appointment": "2026-11-12T15:00:00+00:00",
      "phone": "555-010-0123",
      "provider_id": "100211",
      "provider_name": "Dana Provider",
      "quick_notes": "",
      "record_identifier": "",
      "state": "",
      "street": "",
      "tag_ids": [
        "5520"
      ],
      "tags": [
        "New client"
      ],
      "timezone": "America/New_York",
      "updated_at": "2026-11-05T14:02:11+00:00",
      "zip": ""
    }
  ],
  "count": 1,
  "total": 1
}

Find open times

Find when a provider can be booked for an appointment type, up to 7 days at a time.

Inputs

ProviderprovidertextRequired
Whose calendar to look at.
Appointment typeappointment_typetextRequired
The kind of appointment to fit in.
Fromfrom_datedateRequired
The first day to look at.
Toto_datedate
The last day to look at. Defaults to From.
Contact typecontact_typetext
Only times open for this way of meeting.
Time zonetimezonetext
The time zone the days are in. Defaults to the provider's.
Any providerany_providertrue/false
Look at everyone in your organization, not only this provider.Default: false.

Outputs

countnumber
How many
slotslist
The open times, earliest first
Example output
{
  "count": 1,
  "slots": [
    {
      "fully_booked": false,
      "length_minutes": 60,
      "provider_id": "100211",
      "start": "2026-11-12T15:00:00-05:00"
    }
  ]
}

Get appointment

Get an appointment's details: when, with whom, its type, how it happens and its status.

Inputs

AppointmentappointmenttextRequired
The appointment's Healthie ID, from another Healthie step or the trigger.

Outputs

appointment_type_idtext
Its appointment type's ID
appointment_type_nametext
Its appointment type's name
attendee_idslist
The IDs of everyone attending
client_confirmedtrue/false
False while the client still has to confirm it
client_emailtext
The client's email
client_idtext
The client's ID; empty for a group appointment
client_nametext
The client's name
confirmedtrue/false
True once the provider confirmed it
contact_typetext
How it happens, such as Healthie Video Call or In Person
created_attext
When it was booked (ISO 8601)
idtext
The appointment's Healthie ID
is_grouptrue/false
True for a group appointment
length_minutesnumber
How long it is, in minutes
locationtext
Where it is, for an in-person appointment
notestext
The provider's notes on it, which clients don't see
provider_idtext
The provider's ID
provider_nametext
The provider's name
starttext
When it starts (ISO 8601)
statustext
Its status: Occurred, No-Show, Re-Scheduled, Cancelled, Late Cancellation or Checked-In; empty if none is set
status_changed_attext
When its status last changed (ISO 8601)
updated_attext
When it last changed (ISO 8601)
video_urltext
Its own video link, if one was set
Example output
{
  "appointment_type_id": "4021",
  "appointment_type_name": "Initial Consultation",
  "attendee_ids": [
    "312045"
  ],
  "client_confirmed": true,
  "client_email": "test.patient@example.com",
  "client_id": "312045",
  "client_name": "Test Patient",
  "confirmed": true,
  "contact_type": "Healthie Video Call",
  "created_at": "2026-11-05T14:10:00+00:00",
  "id": "880413",
  "is_group": false,
  "length_minutes": 60,
  "location": "",
  "notes": "",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "start": "2026-11-12T15:00:00+00:00",
  "status": "",
  "status_changed_at": "",
  "updated_at": "2026-11-05T14:10:00+00:00",
  "video_url": ""
}

Get client

Get a client's details: contact details, date of birth, provider, group, tags and next appointment.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.

Outputs

activetrue/false
False once the client is archived
citytext
Their city
countrytext
Their country code
created_attext
When they were added (ISO 8601)
date_of_birthtext
Their date of birth (YYYY-MM-DD)
emailtext
Their email
first_nametext
Their first (preferred) name
gendertext
Their gender, as entered in Healthie
group_idtext
Their client group's ID; empty if none
group_nametext
Their client group's name
idtext
The client's Healthie ID
last_nametext
Their last name
legal_nametext
Their legal first name, if it differs
nametext
Their full name
next_appointmenttext
When their next appointment starts (ISO 8601)
phonetext
Their phone number
provider_idtext
Their primary provider's ID
provider_nametext
Their primary provider's name
quick_notestext
The quick notes providers keep on them
record_identifiertext
Their record identifier (medical record number)
statetext
Their state
streettext
Their street address
tag_idslist
The IDs of the tags on them
tagslist
The names of the tags on them
timezonetext
Their time zone, such as America/New_York
updated_attext
When their record last changed (ISO 8601)
ziptext
Their ZIP or postcode
Example output
{
  "active": true,
  "city": "",
  "country": "",
  "created_at": "2026-11-05T14:02:11+00:00",
  "date_of_birth": "1990-01-01",
  "email": "test.patient@example.com",
  "first_name": "Test",
  "gender": "Female",
  "group_id": "",
  "group_name": "",
  "id": "312045",
  "last_name": "Patient",
  "legal_name": "",
  "name": "Test Patient",
  "next_appointment": "2026-11-12T15:00:00+00:00",
  "phone": "555-010-0123",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "quick_notes": "",
  "record_identifier": "",
  "state": "",
  "street": "",
  "tag_ids": [
    "5520"
  ],
  "tags": [
    "New client"
  ],
  "timezone": "America/New_York",
  "updated_at": "2026-11-05T14:02:11+00:00",
  "zip": ""
}

Get completed form

Get a completed form or chart note with every question and its answer.

Inputs

Completed formcompleted_formtextRequired
The completed form's ID, from another Healthie step or the trigger.

Outputs

answerslist
Each question and its answer, in order
answers_by_questionobject
The answers by their question, to pick one out by name
appointment_idtext
The appointment it belongs to; empty if none
chart_notetrue/false
True for a chart note
chart_note_statustext
For a chart note: CREATED, SIGNED, CO_SIGNED, LOCKED, SIGNED_AND_LOCKED or CO_SIGNED_AND_LOCKED
client_idtext
The client it is about
client_nametext
Their name
created_attext
When it was saved, or the date of service (ISO 8601)
filled_by_idtext
Who filled it in
filled_by_nametext
Their name
form_idtext
The form it fills in
form_nametext
That form's name
idtext
The completed form's ID
lockedtrue/false
True once it is locked against changes
nametext
Its name
updated_attext
When it last changed (ISO 8601)
Example output
{
  "answers": [
    {
      "answer": "Sleep",
      "question": "What would you like help with?",
      "question_id": "880021"
    }
  ],
  "answers_by_question": {
    "What would you like help with?": "Sleep"
  },
  "appointment_id": "",
  "chart_note": false,
  "chart_note_status": "",
  "client_id": "312045",
  "client_name": "Test Patient",
  "created_at": "2026-11-05T15:20:00+00:00",
  "filled_by_id": "312045",
  "filled_by_name": "Test Patient",
  "form_id": "61044",
  "form_name": "Intake Questionnaire",
  "id": "7730021",
  "locked": false,
  "name": "Intake Questionnaire",
  "updated_at": "2026-11-05T15:20:00+00:00"
}

List appointment types

List the kinds of appointment your account offers, with their length and the ways each can happen, such as Healthie Video Call or In Person.

Inputs

Searchsearchtext
Words in the appointment type's name.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

appointment_typeslist
The appointment types
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "appointment_types": [
    {
      "clients_can_book": true,
      "contact_types": [
        "Healthie Video Call",
        "In Person",
        "Phone Call"
      ],
      "id": "4021",
      "is_group": false,
      "length_minutes": 60,
      "name": "Initial Consultation"
    }
  ],
  "count": 1,
  "total": 1
}

List appointments

List your organization's appointments, upcoming ones soonest first and past ones latest first, for a client, provider, type, status or days.

Inputs

Whenwhentext
Which appointments. Defaults to upcoming.One of: future (Upcoming), past, didnt-occur (Didn't happen (cancelled, no-show or rescheduled)). Default: future.
Clientclient_idtext
Only this client's appointments: their Healthie ID.
Providerprovidertext
Only this provider's appointments.
Appointment typeappointment_typetext
Only appointments of this type.
Statusstatustext
Only appointments with this status.One of: Occurred, No-Show, Cancelled, Late Cancellation, Re-Scheduled (Rescheduled), Checked-In (Checked in).
Fromfrom_datedate
Only appointments on or after this day.
Toto_datedate
Only appointments on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

appointmentslist
The appointments found
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "appointments": [
    {
      "appointment_type_id": "4021",
      "appointment_type_name": "Initial Consultation",
      "attendee_ids": [
        "312045"
      ],
      "client_confirmed": true,
      "client_email": "test.patient@example.com",
      "client_id": "312045",
      "client_name": "Test Patient",
      "confirmed": true,
      "contact_type": "Healthie Video Call",
      "created_at": "2026-11-05T14:10:00+00:00",
      "id": "880413",
      "is_group": false,
      "length_minutes": 60,
      "location": "",
      "notes": "",
      "provider_id": "100211",
      "provider_name": "Dana Provider",
      "start": "2026-11-12T15:00:00+00:00",
      "status": "",
      "status_changed_at": "",
      "updated_at": "2026-11-05T14:10:00+00:00",
      "video_url": ""
    }
  ],
  "count": 1,
  "total": 1
}

List completed forms

List completed forms and chart notes with their answers, newest first: a client's, one form's, or everyone's, signed or not.

Inputs

Kindform_typetext
Only forms people filled in, or only chart notes. Leave blank for both.One of: forms (Forms only), chart_notes (Chart notes only).
Clientclient_idtext
Only this client's: their Healthie ID.
Formformtext
Only completions of this form.
Signedsignedtext
Only signed ones, or only ones not signed yet, such as chart notes waiting for a provider.One of: signed, unsigned (Not signed).
Fromfrom_datedate
Only those on or after this day.
Toto_datedate
Only those on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
formslist
The completed forms and chart notes
totalnumber
How many match in all
Example output
{
  "count": 1,
  "forms": [
    {
      "answers": [
        {
          "answer": "Sleep",
          "question": "What would you like help with?",
          "question_id": "880021"
        }
      ],
      "answers_by_question": {
        "What would you like help with?": "Sleep"
      },
      "appointment_id": "",
      "chart_note": false,
      "chart_note_status": "",
      "client_id": "312045",
      "client_name": "Test Patient",
      "created_at": "2026-11-05T15:20:00+00:00",
      "filled_by_id": "312045",
      "filled_by_name": "Test Patient",
      "form_id": "61044",
      "form_name": "Intake Questionnaire",
      "id": "7730021",
      "locked": false,
      "name": "Intake Questionnaire",
      "updated_at": "2026-11-05T15:20:00+00:00"
    }
  ],
  "total": 1
}

List documents

List documents, newest first: those in a client's chart, or your own.

Inputs

Clientclient_idtext
Whose documents: the client's Healthie ID.
Searchsearchtext
Words in the document's name or description.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
documentslist
The documents
totalnumber
How many match in all
Example output
{
  "count": 1,
  "documents": [
    {
      "client_id": "312045",
      "created_at": "2026-11-05T15:40:00+00:00",
      "description": "",
      "extension": "txt",
      "file_type": "text/plain",
      "id": "2210457",
      "name": "Visit summary.txt",
      "owner_id": "100211",
      "owner_name": "Dana Provider",
      "shared": false,
      "updated_at": "2026-11-05T15:40:00+00:00"
    }
  ],
  "total": 1
}

List forms

List your account's forms, such as intake forms and chart note templates.

Inputs

Kindcategorytext
Only forms of this kind. Leave blank for all.One of: intake (Intake forms), charting (Chart note templates), program (Program forms).
Searchsearchtext
Words in the form's name.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
formslist
The forms
totalnumber
How many match in all
Example output
{
  "count": 1,
  "forms": [
    {
      "chart_note": false,
      "created_at": "2026-01-10T09:00:00+00:00",
      "id": "61044",
      "name": "Intake Questionnaire",
      "updated_at": "2026-03-02T11:30:00+00:00"
    }
  ],
  "total": 1
}

List invoices

List invoices, newest first: everyone's or one client's, paid or not.

Inputs

Clientclient_idtext
Only this client's invoices: their Healthie ID.
Statusstatustext
Only invoices in this state.One of: unpaid, partial (Partly paid), paid.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
invoiceslist
The invoices
totalnumber
How many match in all
Example output
{
  "count": 1,
  "invoices": [
    {
      "amount": 150.0,
      "balance_due": 150.0,
      "client_id": "312045",
      "client_name": "Test Patient",
      "created_at": "2026-11-05T16:00:00+00:00",
      "currency": "USD",
      "description": "Other: Follow-up session",
      "id": "45120",
      "invoice_number": "UU-1-2026",
      "notes": "",
      "paid_at": "",
      "provider_id": "100211",
      "provider_name": "Dana Provider",
      "service_date": "2026-11-05T00:00:00+00:00",
      "status": "Not Yet Paid",
      "type": "other"
    }
  ],
  "total": 1
}

Remove tags from client

Take tags off a client. The tags stay in the account for other clients.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
TagstagslistRequired
The tags to take off.

Outputs

client_idtext
The client's ID
countnumber
How many
tagslist
The tags
Example output
{
  "client_id": "312045",
  "count": 1,
  "tags": [
    {
      "id": "5520",
      "name": "New client"
    }
  ]
}

Send form to client

Ask a client to fill in a form in their Healthie portal, such as an intake form or a consent. Healthie emails them a link unless you turn off Email the client.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
FormformtextRequired
The form to fill in.
Email the clientemail_clienttrue/false
Email them a link to the form.Default: true.

Outputs

client_idtext
The client's ID
form_idtext
The form's ID
form_nametext
The form's name
idtext
The request's ID
statustext
Where the request stands, as Healthie says
Example output
{
  "client_id": "312045",
  "form_id": "61044",
  "form_name": "Intake Questionnaire",
  "id": "90233",
  "status": "Not Started"
}

Send message

Send a chat message in Healthie, to a client or a conversation. To a client, it goes to your newest open one-to-one conversation with them, or starts one. Healthie lets the client know as their settings say.

Inputs

MessagemessagetextRequired
What to say. Line breaks are kept.
Clientclient_idtext
Who to message: the client's Healthie ID.
Conversationconversationtext
A conversation's ID, from the trigger or another step, to reply there instead.
Subjectsubjecttext
The subject of a conversation this starts. Defaults to your names.

Outputs

contenttext
What it says
conversation_idtext
The conversation it is in
created_attext
When it was sent (ISO 8601)
idtext
The message's ID
new_conversationtrue/false
True when a new conversation was started for it
sender_idtext
Who sent it
sender_nametext
Their name
Example output
{
  "content": "Your intake form is ready in your portal.",
  "conversation_id": "402219",
  "created_at": "2026-11-05T15:30:00+00:00",
  "id": "1500732",
  "new_conversation": false,
  "sender_id": "100211",
  "sender_name": "Dana Provider"
}

Update appointment

Reschedule an appointment, or change its type, provider, how it happens, status or notes. Fields left blank keep what it has.

Inputs

AppointmentappointmenttextRequired
The appointment's Healthie ID, from another Healthie step or the trigger.
New startstartdate and time
When it now starts.
Appointment typeappointment_typetext
A new appointment type.
Contact typecontact_typetext
A new way it happens, such as Phone Call.
Providerprovidertext
A new provider for it.
Statusstatustext
Its new status, such as Occurred or No-show. If your account bills automatically, Occurred, No-show and Late cancellation can charge the client.One of: Occurred, No-Show, Cancelled, Late Cancellation, Re-Scheduled (Rescheduled), Checked-In (Checked in).
Locationlocationtext
Where it is, for an in-person visit.
Video linkvideo_urltext
A video call link to use instead.
Notesnotestext
Notes on it that only providers see. Replaces what is there.
Email the clientemail_clienttrue/false
Send Healthie's email about a new time or change. Turn off to change it quietly.Default: true.

Outputs

appointment_type_idtext
Its appointment type's ID
appointment_type_nametext
Its appointment type's name
attendee_idslist
The IDs of everyone attending
client_confirmedtrue/false
False while the client still has to confirm it
client_emailtext
The client's email
client_idtext
The client's ID; empty for a group appointment
client_nametext
The client's name
confirmedtrue/false
True once the provider confirmed it
contact_typetext
How it happens, such as Healthie Video Call or In Person
created_attext
When it was booked (ISO 8601)
idtext
The appointment's Healthie ID
is_grouptrue/false
True for a group appointment
length_minutesnumber
How long it is, in minutes
locationtext
Where it is, for an in-person appointment
notestext
The provider's notes on it, which clients don't see
provider_idtext
The provider's ID
provider_nametext
The provider's name
starttext
When it starts (ISO 8601)
statustext
Its status: Occurred, No-Show, Re-Scheduled, Cancelled, Late Cancellation or Checked-In; empty if none is set
status_changed_attext
When its status last changed (ISO 8601)
updated_attext
When it last changed (ISO 8601)
video_urltext
Its own video link, if one was set
Example output
{
  "appointment_type_id": "4021",
  "appointment_type_name": "Initial Consultation",
  "attendee_ids": [
    "312045"
  ],
  "client_confirmed": true,
  "client_email": "test.patient@example.com",
  "client_id": "312045",
  "client_name": "Test Patient",
  "confirmed": true,
  "contact_type": "Healthie Video Call",
  "created_at": "2026-11-05T14:10:00+00:00",
  "id": "880413",
  "is_group": false,
  "length_minutes": 60,
  "location": "",
  "notes": "",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "start": "2026-11-12T15:00:00+00:00",
  "status": "",
  "status_changed_at": "",
  "updated_at": "2026-11-05T14:10:00+00:00",
  "video_url": ""
}

Update client

Change a client's details. Fields left blank keep what they have.

Inputs

Clientclient_idtextRequired
The client's Healthie ID, from another Healthie step or the trigger.
First namefirst_nametext
A new first name.
Last namelast_nametext
A new last name.
Emailemailtext
Their email.
Phonephonetext
Their phone number, such as +1 415 555 0134.
Date of birthdate_of_birthdate
Their date of birth.
Gendergendertext
Their gender, such as Female.
Providerprovidertext
Their primary provider. Defaults to you.
Client groupclient_grouptext
The client group they belong to.
Time zonetimezonetext
Their time zone, such as America/New_York.
Quick notesquick_notestext
Notes about them that only your team sees. Replaces what is there.

Outputs

activetrue/false
False once the client is archived
citytext
Their city
countrytext
Their country code
created_attext
When they were added (ISO 8601)
date_of_birthtext
Their date of birth (YYYY-MM-DD)
emailtext
Their email
first_nametext
Their first (preferred) name
gendertext
Their gender, as entered in Healthie
group_idtext
Their client group's ID; empty if none
group_nametext
Their client group's name
idtext
The client's Healthie ID
last_nametext
Their last name
legal_nametext
Their legal first name, if it differs
nametext
Their full name
next_appointmenttext
When their next appointment starts (ISO 8601)
phonetext
Their phone number
provider_idtext
Their primary provider's ID
provider_nametext
Their primary provider's name
quick_notestext
The quick notes providers keep on them
record_identifiertext
Their record identifier (medical record number)
statetext
Their state
streettext
Their street address
tag_idslist
The IDs of the tags on them
tagslist
The names of the tags on them
timezonetext
Their time zone, such as America/New_York
updated_attext
When their record last changed (ISO 8601)
ziptext
Their ZIP or postcode
Example output
{
  "active": true,
  "city": "",
  "country": "",
  "created_at": "2026-11-05T14:02:11+00:00",
  "date_of_birth": "1990-01-01",
  "email": "test.patient@example.com",
  "first_name": "Test",
  "gender": "Female",
  "group_id": "",
  "group_name": "",
  "id": "312045",
  "last_name": "Patient",
  "legal_name": "",
  "name": "Test Patient",
  "next_appointment": "2026-11-12T15:00:00+00:00",
  "phone": "555-010-0123",
  "provider_id": "100211",
  "provider_name": "Dana Provider",
  "quick_notes": "",
  "record_identifier": "",
  "state": "",
  "street": "",
  "tag_ids": [
    "5520"
  ],
  "tags": [
    "New client"
  ],
  "timezone": "America/New_York",
  "updated_at": "2026-11-05T14:02:11+00:00",
  "zip": ""
}

Upload document

Add a document to a client's chart, from a file or from text you give (saved as a text file). Only your team sees it unless you share it with the client.

Inputs

NamenametextRequired
What to call it, such as Visit summary.pdf.
Clientclient_idtext
Whose chart it goes in: the client's Healthie ID. Leave blank to keep it in your own documents.
Filefiletext
The file to upload. Leave blank to save the text instead.
Texttexttext
Text to save as the document, when there is no file.
Descriptiondescriptiontext
A short description of it.
Share with clientshare_with_clienttrue/false
Let the client see it in their Healthie portal.Default: false.

Outputs

client_idtext
The client it belongs to; empty if none
created_attext
When it was uploaded (ISO 8601)
descriptiontext
Its description
extensiontext
Its file extension
file_typetext
Its file type, such as application/pdf
idtext
The document's ID
nametext
Its name
owner_idtext
Who uploaded it
owner_nametext
Their name
sharedtrue/false
True when the client can see it
updated_attext
When it last changed (ISO 8601)
Example output
{
  "client_id": "312045",
  "created_at": "2026-11-05T15:40:00+00:00",
  "description": "",
  "extension": "txt",
  "file_type": "text/plain",
  "id": "2210457",
  "name": "Visit summary.txt",
  "owner_id": "100211",
  "owner_name": "Dana Provider",
  "shared": false,
  "updated_at": "2026-11-05T15:40:00+00:00"
}

On this page