Actions57
- Booking Actions
- Group Actions
- Offer Actions
- Block Actions
- Block Action Actions
- Reservation Actions
- Reservation Action Actions
- Types Actions
- Folio Actions
- Folio Action Actions
Overview
This node interacts with the "Group" resource of the Apaleo API, specifically supporting the operation to retrieve details about a single group booking by its ID. It is useful in scenarios where you need to fetch comprehensive information about a particular group reservation within a property management or booking system.
Practical examples include:
- Retrieving detailed data for a group booking to display on a dashboard.
- Fetching group booking information to synchronize with another system.
- Accessing additional related data such as blocks or actions associated with the group by using the expand options.
Properties
| Name | Meaning |
|---|---|
| Group ID | The unique identifier of the group booking to retrieve. |
| Expand | Additional related data to include in the response. Options: Blocks, Actions |
- Group ID is required and specifies which group booking to fetch.
- Expand allows including extra nested data in the response, such as:
- Blocks: Related block bookings within the group.
- Actions: Actions performed on the group booking.
Output
The node outputs an array of JSON objects representing the retrieved group booking(s). Each object contains detailed information about the group, including its properties and optionally expanded related data (blocks, actions) if requested.
If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data output.
Dependencies
- Requires an API authentication token credential to access the Apaleo API.
- The base URL for API requests is
https://api.apaleo.com. - No other external dependencies are indicated.
Troubleshooting
Common issues:
- Invalid or missing Group ID will cause the API call to fail.
- Insufficient permissions or invalid API token may result in authorization errors.
- Requesting expansions that are not supported or misspelled may lead to incomplete data or errors.
Error messages:
"Group ID is required": Ensure the Group ID property is set."Unauthorized"or"Invalid token": Verify the API key credential is correct and has proper scopes."Not Found": The specified Group ID does not exist; double-check the ID.
Resolving these typically involves verifying input parameters and API credentials.