Skip to main content
Planyo Online Booking logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: PLANYO_ONLINE_BOOKING
  • Version: 20261101_00

Tools

Slug: PLANYO_ONLINE_BOOKING_ADD_RESERVATIONTool to create a new reservation. Use after gathering resource, timing, and customer details.

Input Parameters

boolean
Set to True to override conflicts and limits
integer
required
ID of the Planyo site to reserve on
integer
Existing Planyo user ID; if not provided, user_email, first_name, and last_name are required
string
Reservation end time; will be converted to UNIX timestamp
string
Language for reservation notifications (e.g., ‘en’, ‘fr’)
integer
required
Number of items or seats to reserve
string
Customer last name; required if user_id not provided
boolean
Set to True to run in admin mode
string
Customer first name; required if user_id not provided
string
Reservation start time; will be converted to UNIX timestamp
string
Customer email; required if user_id not provided
integer
required
ID of the resource to reserve
string
Voucher code to apply
object
Additional custom form fields; keys are field IDs or names; ‘req_’ prefix will be added automatically

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_ADD_USERAdds a user to a Planyo site using an email address and optional personal details. If the user already exists, supplied personal details may be updated; existing login data is not overridden.

Input Parameters

string
User’s fax number
string
User’s postal code
string
User’s city
string
required
User’s email address
string
User’s phone number
string
User’s state or province
string
User’s mobile phone number
string
VAT identification number
string
User’s street address
string
Company name associated with the user
string
User’s country (2-letter ISO code)
string
User’s last name
string
User’s first name
object
Custom fields mapping using field IDs, e.g. {‘3’: ‘value’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_GET_ADDON_LISTTool to retrieve a list of add-ons. Use when you need to inspect or manage add-ons for a specific resource or across the entire site after setting up credentials.

Input Parameters

integer
Site ID to query; deduced from api_key or resource_id if omitted
integer
Numeric user ID for authentication; alternative to login_name/password
string
Password for authentication; required if api_key is not provided
boolean
If true, list add-ons in admin mode when no resource_id is given
string
Username for authentication; required if api_key is not provided
string
Session token for authentication; alternative to login_name/password
integer
Resource ID for which to retrieve add-ons; omit to fetch all site-wide add-ons

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_GET_COUPON_LISTTool to retrieve a list of coupons. Use when you need to fetch all coupons for a specific resource or the entire site (if no resource_id provided).

Input Parameters

integer
Zero-based page number for pagination. Each page returns up to 5000 coupons. Omit to get the first page.
integer
ID of the site to fetch coupons for. Required if no resource_id is provided.
string
Admin email for authentication if required.
integer
ID of the resource to filter coupons. If omitted, returns all coupons for the site.
string
Admin password for authentication if required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITYChecks a Planyo resource’s availability for a specified date and time range and quantity. Availability alone does not guarantee that a reservation can be made; use can_make_reservation to check availability together with other reservation constraints.

Input Parameters

string
End of the interval; will be converted to UNIX timestamp
integer
Number of units requested
integer ("0" | "1")
If set to 1, simulate without creating a reservation
string
Start of the interval; will be converted to UNIX timestamp
integer
End user ID for checking membership or restrictions
boolean
If true, ignore items in the shopping cart
integer
required
ID of the resource to check availability for
integer
Minimum required availability in minutes
boolean
If true, ignore existing reservations
integer ("0" | "1")
If set to 1, return specific time slots within interval
integer ("0" | "1")
If set to 1, only check restrictions, skip conflict checks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTSRetrieves blackout periods for a Planyo resource to help identify unavailable times before booking, optionally bounded by start and end times. This operation is currently unavailable.

Input Parameters

integer
UNIX timestamp to return blackouts up to this time (inclusive).
integer
UNIX timestamp to return blackouts starting from this time (inclusive).
string
Admin email for authentication, if required.
integer
required
ID of the resource to retrieve blackouts for.
string
Password for the admin email, if required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWSLists customer reviews and ratings for a specific Planyo resource, useful for displaying customer feedback. You can limit the number returned; Planyo returns at most the 500 latest reviews.

Input Parameters

integer
Maximum number of reviews to return (1-500)
integer
required
ID of the resource to fetch reviews for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not