RetreatGuru - Apps Documentation

Requirements

Before you set up the credential, make sure you have an active RetreatGuru account and an API access token from your account settings ready.[3]

Get your RetreatGuru credentials

API TokenpasswordRequired
You can find or generate this token in your Retreat Guru admin panel under Settings → API.
[1]

Connect RetreatGuru in WEXTL

Log in to your WEXTL account, add the RetreatGuru 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 RetreatGuru 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 →

RetreatGuru node modules

The list below is a reference of every RetreatGuru node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Each RetreatGuru node module below opens to reveal its input parameters, outputs, and connection requirements.

Watch LeadsTrigger

Output fields[3]

Field	Type
Submitted	text
Lead type	text
First name	text
Last name	text
Full name	text
Email	email
Program	text
Program ID	number
Program URL	url
Program categories	array
Program external code	text
Language	text
Program link	text
Registration link	text
Remote registration link	text
Questions	array

Watch PersonsTrigger

Output fields[3]

Field	Type
Person ID	number
Full name	text
First name	text
Last name	text
Email	email
Registered	text
Questions	array

Watch ProgramsTrigger

Output fields[3]

Field	Type
Program ID	number
Type	text
Self URL	url
Name	text
Name no analzyer	text
Excerpt	text
Content	text
Date type	text
Start date	date
End date	date
List until date	date
Registration open date	date
Package nights	number
Package exclude days	array
Public	boolean
Program type	text
Status	text
Post status	text
Program registration status	text
Registrations URL	url

32other output fields

Watch RegistrationsTrigger

Output fields[3]

Field	Type
Registration ID	number
Type	text
Self URL	url
Submitted	text
Start date	date
End date	date
Status	text
Guest type	text
First name	text
Last name	text
Full name	text
Email	text
Program	text
Program ID	number
Program URL	url
Program categories	array
Program external code	text
Transactions URL	url
Payments URL	url
Items URL	url

24other output fields

Watch RentalsTrigger

Output fields[3]

Field	Type
Rental ID	number
Hash	text
Name	text
Created at	date
Date start	date
Date end	date
Contact email	email
Status	object
Slug	text
Name	text
Confidence	number
Color	text
Organization	object
ID	number
Name	text
Email	text
Phone	text
Website	text
Notes	text
Persons	array
Contact	object
ID	text
First name	text
Last name	text
Email	email
Phone	text
Address	object
Quote	object
Proposal	text
Terms	array
Agreements	array
Program	object
ID	number
Name	text
Registrations	array
Template program	object
ID	number
Name	text
Invoice	object
Items	array
Taxes	array
Taxes sum	object
Subtotal pre tax	object
Grand total	object
Deposit	object
Accepted payment methods	array
Room block	object
ID	number
Name	text
Description	text
Start date	text
End date	text
Date type	object
Lodgings	array
Venues	array
Custom fields	object
Rs inquiry number of people	text
Rs inquiry date notes	text
Rs inquiry event description	text
Rs inquiry special needs	text
Rs inquiry rented before	text
Rental conversion options	object
Add agreement reg transactions	boolean
Auto set group leader to renter	boolean
Tasks	array

1other output field

Watch Room BlocksTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Start date	date
End date	date
Date type	object
Slug	text
Name	text
Lodgings	array

Watch Transaction InfoTrigger

Output fields[3]

Field	Type
Transaction ID	number
Self URL	url
Submitted	text
Trans date	date
Class	text
Category	text
Status	text
Description	text
Notes	text
Staff name	text
Program name	text
Program URL	url
Person name	text
Registration URL	url
Details URL	url
Charge amount	number
Credit amount	number
Associated registration ID	number
Associated registration URL	text
Associated transaction	number

1other output field

Watch Venue BookingsTrigger

Output fields[3]

Field	Type
Venue Booking ID	number
Program ID	number
Program name	text
Program URL	url
Venue ID	number
Venue name	text
Venue URL	url
Venue	object
ID	number
Self URL	url
Name	text
Notes	text
Capacity	number
Venue uses URL	url
Program	object
ID	number
Type	text
Self URL	url
Name	text
Name no analzyer	text
Excerpt	text
Content	text
Date type	text
Start date	date
End date	date
Custom dates	boolean
Start date	date
End date	date
Notes	text

Get a RentalAction

Input fields[3]

Field	Type
Rental ID	choice
Rental Name	text
Start Date	date
End Date	date
Contact Email	text
Status	object
Status Slug	text
Organization	object
Organization ID	number
Organization Name	text
Persons	object
Rental Contact	object
id	number
first_name	text
last_name	text
email	email
phone	text
address	object
Quote	object
proposal	text
terms	object
Agreements	object
id	number
is_accepted	boolean
Program	object
id	number
Template Program	object
id	number
Invoice	object
items	object
Room Block	object
id	number
description	text
start_date	date
end_date	date
date_type	object
Venues	object
blocks	object
Custom Fields	object
rs-inquiry-number-of-people	text
rs-inquiry-date-notes	text
rs-inquiry-event-description	text
rs-inquiry-special-needs	text
rs-inquiry-rented-before	text
Rental Conversion Options	object
add_agreement_reg_transactions	boolean
auto_set_group_leader_to_renter	boolean
Tasks	object
slug	text

Output fields[3]

Field	Type
Rental ID	number
URL	text

List Item TransactionsSearch

Input fields[3]

Field	Type
Item Transaction ID(s)	choice
Program ID(s)	choice
Registration ID(s)	choice
Transaction Class	array
Minimum Date	date
Maximum Date	date
Category	array
Limit	number

Output fields[3]

Field	Type
Is addon	boolean
Discount amount	text
Discount percent	text
Subtotal	text
Tax 1 info	text
Tax 1 amount	text
Tax 2 info	text
Tax 2 amount	text
Grand total	text

List LeadsSearch

Input fields[3]

Field	Type
Lead ID(s)	array
Program ID(s)	choice
Lead Type	choice
Include Registered	boolean
Limit	number

Output fields[3]

Field	Type
Submitted	text
Lead type	text
First name	text
Last name	text
Full name	text
Email	email
Program	text
Program ID	number
Program URL	url
Program categories	array
Program external code	text
Language	text
Program link	text
Registration link	text
Remote registration link	text
Questions	array

List LodgingsSearch

Input fields[3]

Field	Type
Lodging ID(s)	array
Program ID(s)	choice
Language	text
Limit	number

Output fields[3]

Field	Type
Lodging ID	number
Type	text
Self URL	url
Name	text
Description	text
Occupancy type	text
Max occupancy	number
Base price	number
Images	array

List Payment TransactionsSearch

Input fields[3]

Field	Type
Payment ID(s)	array
Program ID(s)	choice
Registration ID(s)	choice
Language	text
Minimum Date	date
Maximum Date	date
Payment Class	array
Category	array
Limit	number

Output fields[3]

Field	Type
Fund method	text
Merchant name	text
Merchant trans ID	text
Merchant profile	text
Merchant account	text
Merchant cc details	text

List Person InformationSearch

Input fields[3]

Field	Type
Person ID(s)	choice
Email	email
Limit	number

Output fields[3]

Field	Type
Person ID	number
Full name	text
First name	text
Last name	text
Email	email
Registered	text
Questions	array

List ProgramsSearch

Input fields[3]

Field	Type
Program ID(s)	choice
Language	text
Category Slug(s)	array
On Date	date
Minimum Start Date	date
Maximum End Date	date
Current & Future Only	boolean
Teacher ID	choice
Venue ID	choice
Program Status	array
Post Status	array
Public Only	boolean
Order	choice
Order By	choice
Fields	array
Include	array
Flexible Date Earliest Start	date
Flexible Date Latest End	date
Limit	number

Output fields[3]

Field	Type
Program ID	number
Type	text
Self URL	url
Name	text
Name no analzyer	text
Excerpt	text
Content	text
Date type	text
Start date	date
End date	date
List until date	date
Registration open date	date
Package nights	number
Package exclude days	array
Public	boolean
Program type	text
Status	text
Post status	text
Program registration status	text
Registrations URL	url

32other output fields

List RegistrationsSearch

Input fields[3]

Field	Type
Registration ID(s)	choice
Person ID	choice
Program ID(s)	choice
Room ID(s)	array
Minimum Submission Date	date
Maximum Submission Date	date
Minimum Stay Date	date
Maximum Stay Date	date
Include	array
Field Source	choice
Limit	number

Output fields[3]

Field	Type
Registration ID	number
Type	text
Self URL	url
Submitted	text
Start date	date
End date	date
Status	text
Guest type	text
First name	text
Last name	text
Full name	text
Email	email
Program	text
Program ID	number
Program URL	text
Program categories	array
Program external code	text
Transactions URL	url
Payments URL	url
Items URL	url

24other output fields

List Rental InformationSearch

Input fields[3]

Field	Type
Rental ID(s)	array
Status	array
Timeline	array
Start Date	date
End Date	date
Min Inquiry Date	date
Max Inquiry Date	date
Limit	number

Output fields[3]

Field	Type
Rental ID	number
Hash	text
Name	text
Created at	date
Date start	date
Date end	date
Contact email	text
Status	object
Slug	text
Name	text
Confidence	number
Color	text
Organization	object
ID	number
Name	text
Email	email
Phone	text
Website	text
Notes	text
Persons	array
Contact	object
ID	text
First name	text
Last name	text
Email	email
Phone	text
Address	object
Quote	object
Proposal	text
Terms	array
Agreements	array
Program	object
ID	number
Name	text
Registrations	array
Template program	object
ID	number
Name	text
Invoice	object
Items	array
Taxes	array
Taxes sum	object
Subtotal pre tax	object
Grand total	object
Deposit	object
Accepted payment methods	array
Room block	object
ID	number
Name	text
Description	text
Start date	date
End date	date
Date type	object
Lodgings	array
Venues	array
Custom fields	object
Rs inquiry number of people	text
Rs inquiry date notes	text
Rs inquiry event description	text
Rs inquiry special needs	text
Rs inquiry rented before	text
Rental conversion options	object
Add agreement reg transactions	boolean
Auto set group leader to renter	boolean
Tasks	array

1other output field

List Room BlocksSearch

Input fields[3]

Field	Type
Room Block ID(s)	array
Start Date	date
End Date	date
Block Type	choice
Room ID(s)	array
Display Lodging ID	number
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Start date	date
End date	date
Date type	object
Slug	text
Name	text
Lodgings	array

List TeachersSearch

Input fields[3]

Field	Type
Teacher ID(s)	choice
Program ID(s)	choice
Language	text
Order	choice
Order By	choice
Limit	number

Output fields[3]

Field	Type
Teacher ID	number
Self URL	url
Name	text
Email	email
Content	text
Categories	array
Hide from marketplace	boolean
Programs URL	url
Images	array
Website	text
Phone	text
Location	text
Post status	text
Video URL	url
Tags	text

List TransactionsSearch

Input fields[3]

Field	Type
Transaction ID(s)	choice
Program ID(s)	choice
Person ID(s)	choice
Registration ID(s)	choice
Minimum Date	date
Maximum Date	date
Transaction Class	array
Category	array
Limit	number

Output fields[3]

Field	Type
Transaction ID	number
Self URL	url
Submitted	text
Trans date	date
Class	text
Category	text
Status	text
Description	text
Notes	text
Staff name	text
Program name	text
Program URL	text
Person name	text
Registration URL	url
Details URL	url
Charge amount	number
Credit amount	number
Associated registration ID	number
Associated registration URL	text
Associated transaction	number

1other output field

List Venue BookingsSearch

Input fields[3]

Field	Type
Booking ID(s)	array
Venue ID	choice
Minimum Date	date
Maximum Date	date
Include	array
Limit	number

Output fields[3]

Field	Type
Venue Booking ID	number
Program ID	number
Program name	text
Program URL	url
Venue ID	number
Venue name	text
Venue URL	url
Venue	object
ID	number
Self URL	url
Name	text
Notes	text
Capacity	number
Venue uses URL	url
Program	object
ID	number
Type	text
Self URL	url
Name	text
Name no analzyer	text
Excerpt	text
Content	text
Date type	date
Start date	date
End date	date
Custom dates	boolean
Start date	date
End date	date
Notes	text

List Venue InfoSearch

Input fields[3]

Field	Type
Venue ID(s)	choice
Limit	number

Output fields[3]

Field	Type
Venue Info ID	number
Self URL	url
Name	text
Notes	text
Capacity	number
Venue uses URL	url

Create a LeadAction

Input fields[3]

Field	Type
Program IDRequired	choice
Lead TypeRequired	choice
First NameRequired	text
Last NameRequired	text
EmailRequired	email
Registration ID	choice
Questions	object
Question Key	text
Answer	text

Output fields[3]

Field	Type
Lead ID	number
URL	text

Create a PersonAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
EmailRequired	text
Questions	object
Question Key	text
Answer	text

Output fields[3]

Field	Type
Person ID	number
URL	text

Create a ProgramAction

Input fields[3]

Field	Type
Program NameRequired	text
Date TypeRequired	choice
Start Date	date
End Date	date
Registration End Date	date
Package Nights	number
Excluded Start Days	array
Program Description	text
Image URL	url
Hide from Marketplace	boolean
Pricing Type	choice
Pricing Options	array
Post Departure Email	choice
Maximum Capacity	number
External Code	text
Categories	array
Public	boolean
Teacher IDs	choice

Output fields[3]

Field	Type
Program ID	number
URL	text

Create a RegistrationAction

Input fields[3]

Field	Type
Program IDRequired	choice
Person ID	choice
First NameRequired	text
Last NameRequired	text
Email	email
Start Date	date
End Date	date
Registration Status	choice
Guest Type	text
Pricing Option	number
Pricing Amount	number
Questions	object
Question Slug	text
Operator	choice
Value	text

Output fields[3]

Field	Type
Registration ID	number
URL	text

Create a RentalAction

Input fields[3]

Field	Type
Rental Name	text
Start Date	date
End Date	date
Contact Email	text
Status	object
Status Slug	text
Organization	object
Organization ID	number
Organization Name	text
Persons	object
Rental Contact	object
Contact ID	number
First Name	text
Last Name	text
Email	email
Phone	text
Address	object
Quote	object
Proposal	text
Terms	object
Agreements	object
id	number
is_accepted	boolean
quote	object
Program	object
id	number
Template Program	object
id	number
Room Block	object
id	number
description	text
start_date	date
end_date	date
date_type	object
Venues	object
id	number
blocks	object
Custom Fields	object
rs-inquiry-number-of-people	text
rs-inquiry-date-notes	text
rs-inquiry-event-description	text
rs-inquiry-special-needs	text
rs-inquiry-rented-before	text
Rental Conversion Options	object
add_agreement_reg_transactions	boolean
auto_set_group_leader_to_renter	boolean
Tasks	object
slug	text

Output fields[3]

Field	Type
Rental ID	number
URL	text

Create a TeacherAction

Input fields[3]

Field	Type
Teacher NameRequired	text
Email	email
Description	text
Categories	array
Hide from Marketplace	boolean
Website	url
Phone	text
Location	text
Post Status	choice
Video URL	url
Tags	text

Output fields[3]

Field	Type
Teacher ID	number
URL	text

Create a TransactionAction

Input fields[3]

Field	Type
Registration IDRequired	choice
Transaction Date	date
Category	text
Status	choice
Description	text
Charge Amount	number
Credit Amount	number

Output fields[3]

Field	Type
Transaction ID	number
URL	text

Delete a LeadAction

Input fields[3]

Field	Type
Lead IDRequired	number

Update a Lead by IDAction

Input fields[3]

Field	Type
Lead IDRequired	number
Program ID	choice
Lead Type	choice
First Name	text
Last Name	text
Email	email
Registration ID	choice
Questions	object
Question Key	text
Answer	text

Output fields[3]

Field	Type
Lead ID	number
URL	text

Update a PersonAction

Input fields[3]

Field	Type
Person IDRequired	choice
First Name	text
Last Name	text
Email	email
Questions	object
Question Key	text
Answer	text

Output fields[3]

Field	Type
Person ID	number
URL	text

Update a ProgramAction

Input fields[3]

Field	Type
Program IDRequired	choice
Program Name	text
Date Type	choice
Start Date	date
End Date	date
Registration End Date	date
Package Nights	number
Excluded Start Days	array
Program Description	text
Image URL	url
Hide from Marketplace	boolean
Pricing Type	choice
Pricing Options	array
Post Departure Email	choice
Maximum Capacity	number
External Code	text
Categories	array
Public	boolean
Teacher IDs	choice

Output fields[3]

Field	Type
Program ID	number
URL	text

Update a RegistrationAction

Input fields[3]

Field	Type
Registration IDRequired	choice
Program ID	choice
Person ID	choice
First Name	text
Last Name	text
Email	email
Start Date	date
End Date	date
Registration Status	choice
Guest Type	text
Pricing Option	number
Pricing Amount	number
Questions	object
Field Slug	text
Value	text

Output fields[3]

Field	Type
Registration ID	number
URL	text

Update a TeacherAction

Input fields[3]

Field	Type
Teacher IDRequired	choice
Teacher Name	text
Email	email
Description	text
Categories	array
Hide from Marketplace	boolean
Website	text
Phone	text
Location	text
Post Status	choice
Video URL	url
Tags	text

Update a TransactionAction

Input fields[3]

Field	Type
Transaction IDRequired	choice
Registration ID	choice
Transaction Date	date
Category	text
Status	choice
Description	text
Charge Amount	number
Credit Amount	number

Output fields[3]

Field	Type
Transaction ID	number
URL	text

Templates

Look for RetreatGuru templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Scheduling category →

References

WEXTL® RetreatGuru Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for RetreatGuru.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.