Requirements
Before you set up the credential, make sure you have an active Phorest account and an API access token from your account settings ready.[3]
Get your Phorest credentials
- UsernametextRequired
For example:
[1]global/[email protected]. - PasswordpasswordRequired
- Business IDtextRequired
- Environment LocationselectRequired
Connect Phorest in WEXTL
- Log in to your WEXTL account, add the Phorest node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Phorest account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Phorest node modules
The list below is a reference of every Phorest node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Phorest node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch AppointmentsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Appointment ID | text |
| Version | number |
| Created at | date |
| Updated at | date |
| Appointment Date | text |
| Start Time | text |
| End Time | text |
| Price | number |
| Staff Request | boolean |
| Staff ID | text |
| Room ID | text |
| Client ID | text |
| Service ID | text |
| Service Name | text |
| State | text |
| Activation State | text |
| Source | text |
| Confirmed | boolean |
Watch ClientsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Linked client mobile | text |
| Land line | text |
| Address | object |
| Street address 1 | text |
| Street address 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Birth date | text |
| Client since | text |
| Gender | text |
| Notes | text |
| Sms marketing consent | boolean |
| Email marketing consent | boolean |
| Sms reminder consent | boolean |
| Email reminder consent | boolean |
| Preferred staff ID | text |
| External ID | text |
| Creating branch ID | text |
| Archived | boolean |
| Banned | boolean |
| Client category ids | array |
| Client ID | text |
| Version | number |
12other output fields
Watch LeadsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Lead ID | number |
| Business ID | text |
| Branch ID | text |
| Mobile | text |
| text | |
| First name | text |
| Last name | text |
| Contactable by email | boolean |
| Contactable by mobile | boolean |
| Status | text |
| Source | text |
| Last activity date | text |
| Sms marketing opt out | boolean |
| Email marketing opt out | boolean |
| Client ID | text |
| Updated by | text |
| Update action | text |
| Ad campaign name | text |
| Message history | array |
| Note | text |
Watch Updated ClientsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Linked client mobile | text |
| Land line | text |
| Address | object |
| Street address 1 | text |
| Street address 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Birth date | text |
| Client since | text |
| Gender | text |
| Notes | text |
| Sms marketing consent | boolean |
| Email marketing consent | boolean |
| Sms reminder consent | boolean |
| Email reminder consent | boolean |
| Preferred staff ID | text |
| External ID | text |
| Creating branch ID | text |
| Archived | boolean |
| Banned | boolean |
| Client category ids | array |
| Client ID | text |
| Version | number |
12other output fields
Get a ClientAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Address | object |
| City | text |
| Country | text |
| Postal Code | text |
| State | text |
| Street Address 1 | text |
| Street Address 2 | text |
| Archived | boolean |
| Banned | boolean |
| Birth Date | date |
| Client Category Ids | array |
| Client ID | text |
| Client Since | date |
| Created at | date |
| Creating Branch ID | text |
| Credit Account | object |
| Credit Days | number |
| Credit Limit | number |
| Outstanding Balance | number |
| Deleted | boolean |
| text | |
| Email Marketing Consent | boolean |
| Email Reminder Consent | boolean |
| External ID | number |
| First Name | text |
| First Visit | text |
| Gender | text |
| Land Line | number |
| Last Name | text |
11other output fields
Get an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Appointment ID | text |
| Version | number |
| Appointment date | date |
| Start time | time |
| End time | time |
| Price | number |
| Staff ID | text |
| Room ID | text |
| Machine ID | text |
| Confirmed | boolean |
| Created at | date |
| Updated at | date |
| Staff request | boolean |
| Preferred staff | boolean |
| Client ID | text |
| Service ID | text |
| Service reward ID | text |
| Course ID | text |
| Course name | text |
| Client course ID | text |
18other output fields
List LeadsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Name | text |
| Status | array |
| Status | text |
| Contactable By Email | boolean |
| Contactable By Mobile | boolean |
| Fetch Message History | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Lead ID | number |
| Business ID | text |
| Branch ID | text |
| Mobile | text |
| text | |
| First name | text |
| Last name | text |
| Contactable by email | boolean |
| Contactable by mobile | boolean |
| Status | text |
| Source | text |
| Last activity date | text |
| Sms marketing opt out | boolean |
| Email marketing opt out | boolean |
| Client ID | text |
| Updated by | text |
| Update action | text |
| Ad campaign name | text |
| Message history | array |
| Note | text |
Search AppointmentsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| From Date | date |
| To Date | date |
| Fetch Canceled | boolean |
| Fetch Deleted | boolean |
| Fetch Archived | boolean |
| Updated From | date |
| Updated To | date |
| Fetch Online Category | boolean |
| Fetch Notes | boolean |
| Group Booking ID | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Appointment ID | text |
| Version | number |
| Appointment date | date |
| Start time | time |
| End time | time |
| Price | number |
| Staff ID | text |
| Room ID | text |
| Machine ID | text |
| Confirmed | boolean |
| Created at | date |
| Updated at | date |
| Staff request | boolean |
| Preferred staff | boolean |
| Client ID | text |
| Service ID | text |
| Service reward ID | text |
| Course ID | text |
| Course name | text |
| Client course ID | text |
18other output fields
Search ClientsSearch
Input fields[3]
| Field | Type |
|---|---|
| Phone | text |
| Updated After | date |
| Updated Before | date |
| First Name | text |
| Last Name | text |
| External ID | text |
| Include Archived | boolean |
| Include Deleted | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Linked client mobile | text |
| Land line | text |
| Address | object |
| Street address 1 | text |
| Street address 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Birth date | text |
| Client since | text |
| Gender | text |
| Notes | text |
| Sms marketing consent | boolean |
| Email marketing consent | boolean |
| Sms reminder consent | boolean |
| Email reminder consent | boolean |
| Preferred staff ID | text |
| External ID | text |
| Creating branch ID | text |
| Archived | boolean |
| Banned | boolean |
| Client category ids | array |
| Client ID | text |
| Version | number |
12other output fields
Activate a BookingAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Booking IDRequired | text |
| Deposit Amount | number |
Cancel a BookingAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Booking IDRequired | text |
Cancel AppointmentsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Check In an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Confirm AppointmentsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Create a BookingAction
Create a Booking NoteAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Booking IDRequired | text |
NoteRequired | text |
Create a ClientAction
Input fields[3]
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
| Mobile | text |
| Linked Client Mobile | text |
| Land Line | text |
| Address | object |
| Street Address 1 | text |
| Street Address 2 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Birth Date | date |
| Client Since | date |
| Gender | choice |
| Notes | text |
| SMS Marketing Consent | boolean |
| Email Marketing Consent | boolean |
| SMS Reminder Consent | boolean |
| Email Reminder Consent | boolean |
| Preferred Staff ID | text |
| External ID | text |
| Creating Branch ID | text |
| Archived | boolean |
| Banned | boolean |
1other input field
Output fields[3]
| Field | Type |
|---|---|
| Linked client mobile | text |
| Land line | text |
| Address | object |
| Street address 1 | text |
| Street address 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Birth date | text |
| Client since | text |
| Gender | text |
| Notes | text |
| Sms marketing consent | boolean |
| Email marketing consent | boolean |
| Sms reminder consent | boolean |
| Email reminder consent | boolean |
| Preferred staff ID | text |
| External ID | text |
| Creating branch ID | text |
| Archived | boolean |
| Banned | boolean |
| Client category ids | array |
| Client ID | text |
| Version | number |
12other output fields
Create a LeadAction
Perform an API Calluniversal
Update a ClientAction
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | choice |
| First Name | text |
| Last Name | text |
| Mobile | text |
| Linked Client Mobile | text |
| Land Line | text |
| Address | object |
| Street Address 1 | text |
| Street Address 2 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Birth Date | date |
| Client Since | date |
| Gender | choice |
| Notes | text |
| SMS Marketing Consent | boolean |
| Email Marketing Consent | boolean |
| SMS Reminder Consent | boolean |
| Email Reminder Consent | boolean |
| Preferred Staff ID | text |
| External ID | text |
| Creating Branch ID | text |
| Archived | boolean |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
| Linked client mobile | text |
| Land line | text |
| Address | object |
| Street address 1 | text |
| Street address 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Birth date | text |
| Client since | text |
| Gender | text |
| Notes | text |
| Sms marketing consent | boolean |
| Email marketing consent | boolean |
| Sms reminder consent | boolean |
| Email reminder consent | boolean |
| Preferred staff ID | text |
| External ID | text |
| Creating branch ID | text |
| Archived | boolean |
| Banned | boolean |
| Client category ids | array |
| Client ID | text |
| Version | number |
12other output fields
Update an Appointment NoteAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Service NoteRequired | text |
Templates
Look for Phorest templates in the WEXTL template library.
Browse templates →Explore alternative apps
- AlfaDocs[2]Practice management for dental clinics — patients, appointments, and records.
- ClinikoPractice management for healthcare providers — appointments, notes, and billing.
- Classe365Student information and school management system for admissions, academics, and administration.
- CharlaAI chatbot and live-chat platform for contacts, articles, and conversations.
- ChatlingAI customer-service agent for chatbot contacts and conversations.
References
- WEXTL® Phorest Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Phorest.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12