> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Planyo Online Booking

> Planyo is an online reservation system which can be used by any business taking bookings: for days, nights, hours or minutes, or scheduled events.

![Planyo Online Booking logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/planyo_online_booking.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=8af9126df2c153e914a69cff81afdabf)

* **Category:** scheduling & booking
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 7
* **Triggers:** 0
* **Slug:** `PLANYO_ONLINE_BOOKING`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Reservation
>
> **Slug:** `PLANYO_ONLINE_BOOKING_ADD_RESERVATION`
>
> Tool to create a new reservation. Use after gathering resource, timing, and customer details.
>
> #### Input Parameters
>
> **force** `boolean`
>
> Set to True to override conflicts and limits
>
> **site\_id** `integer` *required*
>
> ID of the Planyo site to reserve on
>
> **user\_id** `integer`
>
> Existing Planyo user ID; if not provided, user\_email, first\_name, and last\_name are required
>
> **end\_time** `string`
>
> Reservation end time; will be converted to UNIX timestamp
>
> **language** `string`
>
> Language for reservation notifications (e.g., 'en', 'fr')
>
> **quantity** `integer` *required*
>
> Number of items or seats to reserve
>
> **last\_name** `string`
>
> Customer last name; required if user\_id not provided
>
> **admin\_mode** `boolean`
>
> Set to True to run in admin mode
>
> **first\_name** `string`
>
> Customer first name; required if user\_id not provided
>
> **start\_time** `string`
>
> Reservation start time; will be converted to UNIX timestamp
>
> **user\_email** `string`
>
> Customer email; required if user\_id not provided
>
> **resource\_id** `integer` *required*
>
> ID of the resource to reserve
>
> **voucher\_code** `string`
>
> Voucher code to apply
>
> **custom\_fields** `object`
>
> Additional custom form fields; keys are field IDs or names; 'req\_' prefix will be added automatically
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add User
>
> **Slug:** `PLANYO_ONLINE_BOOKING_ADD_USER`
>
> Adds 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
>
> **fax** `string`
>
> User's fax number
>
> **zip** `string`
>
> User's postal code
>
> **city** `string`
>
> User's city
>
> **email** `string` *required*
>
> User's email address
>
> **phone** `string`
>
> User's phone number
>
> **state** `string`
>
> User's state or province
>
> **mobile** `string`
>
> User's mobile phone number
>
> **vat\_id** `string`
>
> VAT identification number
>
> **address** `string`
>
> User's street address
>
> **company** `string`
>
> Company name associated with the user
>
> **country** `string`
>
> User's country (2-letter ISO code)
>
> **last\_name** `string`
>
> User's last name
>
> **first\_name** `string`
>
> User's first name
>
> **custom\_fields** `object`
>
> Custom fields mapping using field IDs, e.g. \{'3': 'value'}
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Add-on List
>
> **Slug:** `PLANYO_ONLINE_BOOKING_GET_ADDON_LIST`
>
> Tool 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
>
> **site\_id** `integer`
>
> Site ID to query; deduced from api\_key or resource\_id if omitted
>
> **user\_id** `integer`
>
> Numeric user ID for authentication; alternative to login\_name/password
>
> **password** `string`
>
> Password for authentication; required if api\_key is not provided
>
> **admin\_mode** `boolean`
>
> If true, list add-ons in admin mode when no resource\_id is given
>
> **login\_name** `string`
>
> Username for authentication; required if api\_key is not provided
>
> **session\_id** `string`
>
> Session token for authentication; alternative to login\_name/password
>
> **resource\_id** `integer`
>
> Resource ID for which to retrieve add-ons; omit to fetch all site-wide add-ons
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Coupon List
>
> **Slug:** `PLANYO_ONLINE_BOOKING_GET_COUPON_LIST`
>
> Tool 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
>
> **page** `integer`
>
> Zero-based page number for pagination. Each page returns up to 5000 coupons. Omit to get the first page.
>
> **site\_id** `integer`
>
> ID of the site to fetch coupons for. Required if no resource\_id is provided.
>
> **admin\_email** `string`
>
> Admin email for authentication if required.
>
> **resource\_id** `integer`
>
> ID of the resource to filter coupons. If omitted, returns all coupons for the site.
>
> **admin\_password** `string`
>
> Admin password for authentication if required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Resource Availability
>
> **Slug:** `PLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITY`
>
> Checks 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
>
> **end\_time** `string`
>
> End of the interval; will be converted to UNIX timestamp
>
> **quantity** `integer`
>
> Number of units requested
>
> **test\_mode** `integer ("0" | "1")`
>
> If set to 1, simulate without creating a reservation
>
> **start\_time** `string`
>
> Start of the interval; will be converted to UNIX timestamp
>
> **end\_user\_id** `integer`
>
> End user ID for checking membership or restrictions
>
> **ignore\_cart** `boolean`
>
> If true, ignore items in the shopping cart
>
> **resource\_id** `integer` *required*
>
> ID of the resource to check availability for
>
> **min\_duration** `integer`
>
> Minimum required availability in minutes
>
> **ignore\_reservations** `boolean`
>
> If true, ignore existing reservations
>
> **check\_specific\_slots** `integer ("0" | "1")`
>
> If set to 1, return specific time slots within interval
>
> **preliminary\_filtering** `integer ("0" | "1")`
>
> If set to 1, only check restrictions, skip conflict checks
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Resource Blackouts
>
> **Slug:** `PLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTS`
>
> Retrieves 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
>
> **end\_time** `integer`
>
> UNIX timestamp to return blackouts up to this time (inclusive).
>
> **start\_time** `integer`
>
> UNIX timestamp to return blackouts starting from this time (inclusive).
>
> **admin\_email** `string`
>
> Admin email for authentication, if required.
>
> **resource\_id** `integer` *required*
>
> ID of the resource to retrieve blackouts for.
>
> **admin\_password** `string`
>
> Password for the admin email, if required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Resource Reviews
>
> **Slug:** `PLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWS`
>
> Lists 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
>
> **limit** `integer`
>
> Maximum number of reviews to return (1-500)
>
> **resource\_id** `integer` *required*
>
> ID of the resource to fetch reviews for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
