Actions45
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Reservation Actions
- Folio Actions
- Types Actions
Overview
This node interacts with the "Group" resource of the Apaleo API, specifically supporting the operation to get a count of groups. It allows users to filter and count groups based on various criteria such as text search, associated property IDs, and date ranges. This is useful in scenarios where you need to quickly retrieve the number of groups matching certain filters without fetching full group details.
Practical examples include:
- Counting how many guest groups have been created or updated within a specific date range.
- Filtering groups by properties they are associated with to understand group distribution across properties.
- Searching groups by partial text matches on names or company names to get quick statistics.
Properties
| Name | Meaning |
|---|---|
| Text Search | Search text to filter groups by name, lastname, firstname, email, or company name. |
| Property IDs | Filter groups by one or more property IDs (multiple values allowed). |
| From | Start date for filtering groups (only groups from this date onwards will be counted). |
| To | End date for filtering groups (only groups up to this date will be counted). |
Output
The output is an array containing a single JSON object representing the count of groups that match the specified filters. The exact structure depends on the underlying API response but typically includes a numeric count field indicating how many groups matched the query.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Apaleo API.
- The node uses the base URL
https://api.apaleo.comfor all requests. - Proper configuration of the API authentication token is necessary in n8n credentials.
Troubleshooting
- Common issues:
- Invalid or expired API token: Ensure the API key credential is valid and refreshed if needed.
- Incorrect date formats for "From" and "To": Use ISO 8601 date-time strings.
- Empty or invalid property IDs: Confirm property IDs exist and are correctly formatted.
- Error messages:
- Authentication errors usually indicate problems with the API key; reconfigure credentials.
- Validation errors may occur if filters are malformed; verify input property values.
- Network or API downtime errors require checking connectivity or Apaleo service status.
Links and References
- Apaleo API Documentation
- Apaleo Group Resource (for detailed API parameters and responses)