Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Group → GET group

AI-generated

Overview

This node operation retrieves detailed information about a specific group booking from the Apaleo API. It is useful in scenarios where you need to fetch data about a group reservation, such as for managing group bookings in a hotel or event management system. For example, a hotel front desk system could use this operation to display all details of a group booking by its ID, including optional expanded data like blocks or actions associated with the group.

Use Case Examples

  1. Retrieve a group booking by its ID to display booking details in a management dashboard.
  2. Fetch additional related data such as blocks or actions linked to the group booking by using the 'Expand' option.

Properties

Name Meaning
Group ID The unique identifier of the group booking to retrieve. This is a required field for the operation.
Expand Optional additional data to include in the response, such as 'Blocks' or 'Actions' related to the group booking.

Output

JSON

  • groupId - The ID of the retrieved group booking.
  • groupDetails - Detailed information about the group booking, including any expanded data requested.

Dependencies

  • Requires an API authentication token (access token) for the Apaleo API.

Troubleshooting

  • Common issues include invalid or missing Group ID, which will cause the API to return an error indicating the group was not found.
  • If the access token is invalid or expired, authentication errors will occur. Refresh or provide a valid API token.
  • Incorrect usage of the 'Expand' parameter may result in incomplete or unexpected data in the response.

Links

Discussion