API - Planyo Web Services - get_reservation_actions

You are here: Planyo » Help » API » get_reservation_actions

get_reservation_actions

Description:

This function lists reservation actions (events), such as modifications, cancellations etc. You can optionally narrow down the events returned to a specific reservation ID, to all reservations of a specific customer, to specific time range, or to a specific event.

Input:

reservation_id int optional

You can limit the events returned to a single reservation ID

user_id int optional

You can limit the events returned to reservations of given customer ID

start_time DateTime optional

You can limit the events returned to those starting after the specified date/time

end_time DateTime optional

You can limit the events returned to those starting before the specified date/time

event_type EventType optional

You can limit the events returned to a specific event type.

site_id int optional

For metasite api keys, you need to pass a specific Planyo site ID. For single sites, you can leave this empty

method string required

must be set to get_reservation_actions

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.

Output:

results array

Array whose items are arrays with the following keys: moderator (usually available in case a moderator or an admin triggered an action), moderator_id (user_id of the moderator), event_type (numeric event type, see the event_type parameter for the possible values), time (time of event), comments (comments, if any), reservation_id, resource_id, resource_name

API playground:

Click here to test this function in the API playground.