3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get My User" operation in the "My User" resource is designed to retrieve information about the currently authenticated user from the 3CX telephony system. This node is useful when you want to fetch details such as user profile data, settings, or related entities associated with the logged-in user.

Typical use cases include:

  • Displaying or processing the current user's profile information within an automation workflow.
  • Fetching user-specific settings or permissions to conditionally control subsequent workflow steps.
  • Integrating user data into reports or notifications.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set.
- Search ($search) Searches items by phrases; automatically adds quotes if the phrase contains spaces.
- Filter ($filter) Filters items based on property values (e.g., State eq 'Connected').
- Count ($count) Includes a count of total items matching the query when set to true.
- Orderby ($orderby) Orders items by specified property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Selects specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expands related entities to include additional linked data (e.g., RelatedEntity1).

Note: The $select and $expand options appear twice but serve the same purpose — to specify which fields to return and which related entities to expand.

Output

The node outputs JSON data representing the current user's information retrieved from the 3CX API. The structure depends on the selected properties and expansions but typically includes user identifiers, names, contact details, and any expanded related entities.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON user data.

Dependencies

  • Requires an API authentication token credential for the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access user data.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search strings may cause API errors. Validate these expressions according to OData query standards.
  • Empty results: If no user data is returned, verify that the authenticated user exists and that the API endpoint is reachable.
  • Network issues: Confirm that the 3CX server URL is correct and accessible from the n8n environment.

Links and References

Discussion