Actions45
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Reservation Actions
- Folio Actions
- Types Actions
Overview
This node interacts with the Apaleo API to retrieve allowed values for specific types within a given country context. Specifically, it supports fetching allowed values for "Gender" and "Identification Type" categories filtered by country code and optional search criteria. This is useful in scenarios where you need to validate or populate dropdowns with standardized values based on locale, such as user registration forms, identity verification processes, or booking systems that require localized data.
For example, if you want to get all valid gender options recognized in Germany or all identification document types accepted in the United States, this node operation will provide those lists, optionally filtered and paginated.
Properties
| Name | Meaning |
|---|---|
| Type | The category of allowed values to retrieve. Options: "Gender", "Identification Type". |
| Country Code | The ISO 3166-1 alpha-2 country code specifying the country context for the allowed values (e.g., "DE" for Germany). |
| Additional Fields | Optional filters and pagination controls: |
| - Text Search | Free text filter to return only values containing the specified string. |
| - Page Number | The page number for paginated results (1-based). Default is 1. |
| - Page Size | Number of items per page. If not set or non-positive, all items are returned ignoring pagination. |
| - Sort | Sorting order of results. Options include "Value Ascending" and "Value Descending". |
Output
The output is an array of JSON objects representing the allowed values for the requested type and country. Each item typically contains fields describing the value (such as code and display name). The exact structure depends on the API response but generally includes:
value: The code or identifier of the allowed value.display: A human-readable label for the value.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Apaleo API via an API key credential.
- The node expects the API access token to be available through configured credentials.
- Network connectivity to
https://api.apaleo.comis necessary.
Troubleshooting
- Invalid Country Code: Providing an incorrect or unsupported ISO 3166-1 alpha-2 country code may result in empty results or errors. Verify the country code format.
- Missing or Invalid API Credentials: Authentication failures will prevent data retrieval. Ensure the API key credential is correctly configured and valid.
- Pagination Issues: Setting a non-positive page size disables pagination and returns all items; large datasets might cause performance issues.
- Text Search Filtering: If no results appear after applying a text search filter, try broadening or removing the filter to confirm data availability.
- API Rate Limits: Excessive requests may trigger rate limiting by the Apaleo API, causing temporary failures.