| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://www.planyo.com/rest/ | link | — | — | — |
Actions (179)
Sites · 104
- Add URL to admin favorites
Add a backend URL to a user's favorites.
documented - Add URL to admin favorites (alt.)
Add a backend URL to a user's favorites.
documented - Add URL to admin favorites (alt.)
Add a backend URL to a user's favorites (alt.).
documented - Add URL to admin favorites (alt.)
Add a backend URL to a user's favorites (alt.).
documented - Add URL to admin favorites (alt.)
Add a backend URL to a user's favorites (alt.).
documented - Add URL to admin favorites (alt.)
Add a backend URL to a user's favorites (alt.).
documented - Add site
Add a new site to your metasite.
documented - Add site image
Add an image to a site.
documented - Add site image (alt.)
Add an image to a site.
documented - Add site image (alt.)
Add an image to a site (alt.).
documented - Add site image (alt.)
Add an image to a site (alt.).
documented - Add site image (alt.)
Add an image to a site (alt.).
documented - Add site image (alt.)
Add an image to a site (alt.).
documented - Add site moderator
Add a moderator to a site.
documented - Delete custom property (site alt.)
Delete a site-level custom property definition (alt.).
documented - Delete custom property (site alt.)
Delete a site-level custom property definition (alt.).
documented - Delete custom property (site alt.)
Delete a site-level custom property definition (alt.).
documented - Delete custom property (site alt.)
Delete a site-level custom property definition (alt.).
documented - Delete custom property (site alt.)
Delete a site-level custom property definition (alt.).
documented - Delete custom property (site)
Delete a site-level custom property definition.
documented - Get form items (site alt.)
Get site-wide form items (alt.).
documented - Get form items (site alt.)
Get site-wide form items (alt.).
documented - Get form items (site alt.)
Get site-wide form items (alt.).
documented - Get form items (site alt.)
Get site-wide form items (alt.).
documented - Get form items (site alt.)
Get site-wide form items (alt.).
documented - Get form items (site)
Get reservation form items for the entire site.
documented - Get iCal feed URL (site alt.)
Get a site-alt iCal feed URL.
documented - Get iCal feed URL (site alt.)
Get a site-alt iCal feed URL.
documented - Get iCal feed URL (site alt.)
Get a site-alt iCal feed URL.
documented - Get iCal feed URL (site alt.)
Get a site-alt iCal feed URL.
documented - Get iCal feed URL (site alt.)
Get a site-alt iCal feed URL.
documented - Get iCal feed URL (site)
Get iCal feed URL for a site.
documented - Get pricing manager rules
List pricing rules from Pricing Manager.
documented - Get pricing manager rules (alt.)
List pricing rules (alt.).
documented - Get pricing manager rules (alt.)
List pricing rules (alt.).
documented - Get pricing manager rules (alt.)
List pricing rules (alt.).
documented - Get pricing manager rules (alt.)
List pricing rules (alt.).
documented - Get pricing manager rules (alt.)
List pricing rules (alt.).
documented - Get site custom property
Get a site-level custom property value.
documented - Get site custom property (alt.)
Get a site-level custom property value (alt.).
documented - Get site custom property (alt.)
Get a site-level custom property value (alt.).
documented - Get site custom property (alt.)
Get a site-level custom property value (alt.).
documented - Get site custom property (alt.)
Get a site-level custom property value (alt.).
documented - Get site custom property (alt.)
Get a site-level custom property value (alt.).
documented - Get site info
Get information about a site.
documented - Get site info (alt.)
Get site info (alt.).
documented - Get site info (alt.)
Get site info (alt.).
documented - Get site info (alt.)
Get site info (alt.).
documented - Get site info (alt.)
Get site info (alt.).
documented - Get site info (alt.)
Get site info (alt.).
documented - List reviews
List site reviews.
documented - List site reviews (alt.)
List site reviews (alt.).
documented - List site reviews (alt.)
List site reviews (alt.).
documented - List site reviews (alt.)
List site reviews (alt.).
documented - List site reviews (alt.)
List site reviews (alt.).
documented - List site reviews (alt.)
List site reviews (alt.).
documented - List sites
List sites within a metasite.
documented - List sites (alt.)
List sites (alt.).
documented - List sites (alt.)
List sites (alt.).
documented - List sites (alt.)
List sites (alt.).
documented - List sites (alt.)
List sites (alt.).
documented - List sites (alt.)
List sites (alt.).
documented - Modify site
Modify site information.
documented - Modify site (alt.)
Modify site (alt.).
documented - Modify site (alt.)
Modify site (alt.).
documented - Modify site (alt.)
Modify site (alt.).
documented - Modify site (alt.)
Modify site (alt.).
documented - Modify site (alt.)
Modify site (alt.).
documented - Remove URL from admin favorites
Remove a URL from a user's admin favorites.
documented - Remove URL from admin favorites (alt.)
Remove a URL from user's admin favorites (alt.).
documented - Remove URL from admin favorites (alt.)
Remove a URL from admin favorites (alt.).
documented - Remove URL from admin favorites (alt.)
Remove a URL from admin favorites (alt.).
documented - Remove URL from admin favorites (alt.)
Remove a URL from admin favorites (alt.).
documented - Remove pricing manager rule
Remove a Pricing Manager rule.
documented - Remove pricing manager rule (alt.)
Remove a Pricing Manager rule (alt.).
documented - Remove pricing manager rule (alt.)
Remove a Pricing Manager rule (alt.).
documented - Remove pricing manager rule (alt.)
Remove a Pricing Manager rule (alt.).
documented - Remove pricing manager rule (alt.)
Remove a Pricing Manager rule (alt.).
documented - Remove site custom property definition
Remove a site-level custom property definition.
documented - Remove site image
Remove a site image.
documented - Remove site image (alt.)
Remove a site image (alt.).
documented - Remove site image (alt.)
Remove a site image (alt.).
documented - Remove site image (alt.)
Remove a site image (alt.).
documented - Remove site image (alt.)
Remove a site image (alt.).
documented - Remove site moderator
Remove a moderator from a site.
documented - Remove site moderator (alt.)
Remove a site moderator (alt.).
documented - Remove site moderator (alt.)
Remove a site moderator (alt.).
documented - Remove site moderator (alt.)
Remove a site moderator (alt.).
documented - Set payment gateway
Configure the payment gateway for a site.
documented - Set site custom properties (bulk)
Set multiple site-level properties.
documented - Set site custom properties (bulk) (alt.)
Set multiple site-level properties (alt.).
documented - Set site custom properties (bulk) (alt.)
Set multiple site-level properties (alt.).
documented - Set site custom properties (bulk) (alt.)
Set multiple site-level properties (alt.).
documented - Set site custom properties (bulk) (alt.)
Set multiple site-level properties (alt.).
documented - Set site custom property
Set a site-level custom property.
documented - Set site custom property (alt.)
Set a site-level custom property (alt.).
documented - Set site custom property (alt.)
Set a site-level custom property (alt.).
documented - Set site custom property (alt.)
Set a site-level custom property (alt.).
documented - Set site custom property (alt.)
Set a site-level custom property (alt.).
documented - Set site payment gateway
Configure the payment gateway for a site.
documented - Set site payment gateway (alt.)
Configure the payment gateway for a site (alt.).
documented - Set site payment gateway (alt.)
Configure the payment gateway for a site (alt.).
documented - Set site payment gateway (alt.)
Configure the payment gateway for a site (alt.).
documented - Set site payment gateway (alt.)
Configure the payment gateway for a site (alt.).
documented
Resources · 26
- Add custom property definition
Add a new custom property definition.
documented - Add resource
Add a new resource by copying an existing one.
documented - Add resource image
Add an image to a resource.
documented - Delete custom property
Delete a custom property definition.
documented - Delete custom property
Deletes a property by name (custom resource/user/site property).
documented - Get bundle contents
Get bundle contents and pricing for a bundle.
documented - Get custom property
Get custom property value.
documented - Get custom property definition
Get details of a custom resource/user/site property.
documented - Get custom property value
Returns the value of a custom property.
documented - Get event times
Lists all event times of an event-type resource.
documented - Get form items
Return reservation form items for a resource or site.
documented - Get iCal feed URL
Get iCal feed URL for metasite/site/resource.
documented - Get package contents
Get package contents and pricing for a package.
documented - Get resource info
Get resource info including photos and properties.
documented - Get resource pricing
Get pricing rules for all resources.
documented - Get simplified daily pricing
Get daily prices in simplified daily pricing format.
documented - Get simplified daily restrictions
Get daily restrictions in simplified daily format.
documented - List resources
List resources with optional filters.
documented - Modify resource
Modify an existing resource.
documented - Remove custom property definition
Remove a custom property definition.
documented - Remove resource
Remove an existing resource.
documented - Remove resource image
Remove a resource image.
documented - Set custom properties (bulk)
Sets multiple custom properties for a particular type.
documented - Set custom properties (bulk)
Set multiple custom properties at once.
documented - Set custom property
Sets a single custom property value.
documented - Set custom property
Set a custom property value.
documented
Reservations · 20
- Add reservation payment
Adds a payment for a reservation. You may not pass customer's credit card numbers in any fields.
documented - Check if reservation is possible
Returns true if a reservation can be made or false if it's not possible (depending on availability and other constraints).
documented - Delete reservation
Permanently deletes a reservation (cannot be undone).
documented - Get reservation actions
Lists actions/events (e.g., modifications, cancellations) for reservations.
documented - Get reservation data
Returns details of a reservation.
documented - Get reservation payment amount
Returns payment information for a given reservation.
documented - List payments
Lists all payments for reservations.
documented - List payments for a reservation
Lists payments made for a specific reservation.
documented - List promotable reservations
Lists waiting list entries that can be promoted to a valid reservation.
documented - List reservations
Lists reservations that start within a time period or were created within a time period.
documented - Make reservation
Enters a new reservation into the system.
documented - Modify reservation
Modifies an existing reservation.
documented - Modify reservation payment
Changes the status of a reservation payment.
documented - Perform reservation administrative action
Performs an administrative action (e.g., confirm, cancel) on a reservation.
documented - Remove reservation payment
Deletes a payment from a reservation.
documented - Reservation search
Finds reservations by text query.
documented - Search reservations by form item
Finds reservations by a specific form item value.
documented - Set reservation color
Sets a color for a reservation.
documented - Set reservation notes
Sets user/admin notes for a reservation.
documented - Set reservation price
Sets a custom price for a reservation.
documented
Availability · 16
- Add recurring vacation
Adds a new recurring vacation for a resource or site.
documented - Add vacation
Adds a new one-time vacation.
documented - Add vacation (alt.)
Adds a new one-time vacation.
documented - Check reservation viability (availability)
Returns true if reservation can be made or false if possible, similar to can_make_reservation but in availability context.
documented - Check resource availability
Returns availability for a given time period.
documented - Get event times
Lists event times for an event-type resource.
documented - Get iCal feed URL
Gets the iCal feed URL for metasites/sites/resources.
documented - Get resource usage
Returns usage/availability information for a resource/site over a period.
documented - Get resource usage for month
Returns usage/availability information for a resource/site for an entire month.
documented - Get weekly schedule
Lists weekly vacations/working hours for resources.
documented - List vacations
Lists vacations within a time range.
documented - Remove vacation
Removes an existing vacation.
documented - Resource search
Search available resources for a given period.
documented - Set event times
Sets new times for an event-type resource.
documented - Set resource availability
Bulk set availability for a number of days.
documented - Set weekly schedule
Specifies regular working/unavailable hours for resources.
documented
Prices · 13
- Add additional product
Add a new additional product to your site.
documented - Add custom product
Add a new custom product to a reservation.
documented - Add product image
Add an image to an additional product.
documented - Get rental price
Returns the price of a rental for a given resource and time window.
documented - Get reservation products
Get detailed information about reservation's additional products.
documented - List additional products
List defined additional products.
documented - Modify additional product
Modify an existing additional product.
documented - Recalculate price
Recalculates the price for an existing reservation.
documented - Remove additional product
Remove an existing additional product.
documented - Remove custom product
Remove a custom product.
documented - Remove product image
Remove an additional product image.
documented - Set product usage for reservation
Add or remove products usage for a given reservation (without triggering notifications or price recalculation).
documented - Set reservation products
Set or reset all additional product usage for a reservation.
documented