3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Hotel Services" operation retrieves a list of hotel services from the 3CX telephony system API. This node is useful for scenarios where you want to fetch and display available hotel services, filter or search through them, or integrate hotel service data into workflows such as booking systems, customer support automation, or reporting dashboards.

For example, you might use this node to:

  • Retrieve all hotel services currently available.
  • Search for specific services by name or description.
  • Filter services based on status or other properties.
  • Paginate through large sets of services using skip and top options.
  • Select only certain fields to optimize data transfer.

Properties

Name Meaning
$top Show only the first n items (limit the number of results returned).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of total items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities (comma-separated list of related entity names).

These options allow fine-grained control over the query to the hotel services endpoint, enabling filtering, sorting, paging, and shaping the returned data.

Output

The node outputs JSON data representing the hotel services retrieved from the API. The structure typically includes an array of hotel service objects with properties depending on the $select option or default fields if none specified.

If the $count option is enabled, the output may also include metadata about the total number of items available.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system API.
  • The base URL for the API is configured via credentials and must point to a valid 3CX server endpoint.
  • The node sends HTTP requests with appropriate query parameters based on the input properties.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in credentials is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData query options can cause API errors. Validate these strings carefully.
  • Empty results: If no hotel services are returned, check filters and search terms; also verify that the 3CX server has hotel services configured.
  • Network issues: Confirm that the server URL is correct and reachable from the n8n instance.

Links and References

Discussion