3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list tenant properties. It is useful for scenarios where you need to retrieve and manage configuration or metadata related to tenants within a 3CX environment. For example, you might use this node to fetch a filtered or paginated list of tenant properties to display in a dashboard or to automate tenant management workflows.

Properties

Name Meaning
Options A collection of query options to control the listing of tenant properties:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by search phrases; supports automatic quoting if phrase contains spaces.
- Filter ($filter) Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data.

Output

The node outputs JSON data representing the list of tenant properties retrieved from the 3CX API. The structure corresponds to the queried properties and may include pagination metadata if requested. If the $count option is enabled, the output will also contain the total count of matching items.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid query parameters: Using incorrect syntax in filter, orderby, or other query options can cause API errors. Validate OData query expressions carefully.
  • Empty results: Check if filters or search terms are too restrictive or incorrectly formatted.
  • Network issues: Verify connectivity to the 3CX server URL and that it is reachable from the n8n instance.

Links and References

Discussion