Returns information for given resource, including photos and resource-specific properties defined in the admin panel in: Site settings / Custom resource properties
resource_id int required
ID of the resource
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key
. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp
Resource name translated to the language passed in the language parameter
Number of units available
Planyo site ID
Reservation approval mode
Category of the resource
Resource's sharing mode
Resource is available on working days from this time (ignore for day-based resources)
Resource is available on working days until this time (ignore for day-based resources)
Allowed start quarters (ignore for day-based resources)
Base time unit of the resource (day-based, hour-based or quarter-based)
Price of one unit (returned as float) or URL for custom pricing
Comma-seprated unit names, in case the resource has quantity greater than 1 and units have defined names
If the resource has a limited choice of durations, they will be listed in this array. The keys are duration labels and the values are durations in hours
Currency in which prices are expressed (3-letter ISO 4217 code)
True for over-night rentals (e.g. hotels, vacation homes)
True if the resource is marked as published, false if it's unpublished.
Max. quantity allowed for a single reservation
This is the pre-payment (deposit) amount set in resource settings / reservation process. Value is returned as percentage (e.g. 100%) or as a numeric value (if fixed amount).
The max. number of hours before rental when the customer can pay the partial pre-payment (deposit) amount. After this time point, the full amount must be payed.
Array whose items are resource-specific properties (name => value) defined in the admin panel in: Site settings / Custom resource properties
Minimum rental time expressed in hours
Maximum rental time expressed in hours
Resource setting Restrict starting times
. This only applies to hour-based resources. The different times should be comma-separated.
Resource setting Min. time between reservation and rental
. This is an integer, time is expressed in hours
Resource setting Max. time between reservation and rental
. This is an integer, time is expressed in days.
Minimum time between consecutive rentals, expressed in hours
For event-type resources, you can specify comma-separated start dates or start dates and times (in the same way as in resource settings).
Array whose items are named arrays with following keys: id (unique photo ID), path (URL of the photo), title (optional title)
ID of the resource admin (NULL if not set)
Name of the resource admin
Email address of the resource admin
Click here to test this function in the API playground.