PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Overview

The PortaOne node for n8n, specifically with the Customer Extensions resource and the Get All operation, retrieves a list of customer extension records from the PortaOne API. This node is useful in scenarios where you need to fetch and process telephony extension data associated with customers—such as synchronizing extension lists, auditing extension usage, or integrating extension information into other business workflows.

Practical examples:

  • Automatically exporting all extensions for a given customer to a CRM.
  • Filtering and listing only published extensions for reporting.
  • Fetching detailed extension info for internal audits.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields A collection of optional filters and parameters:
- Account ID: Filter by account.
- Detailed Info: Whether to return detailed information (Yes/No).
- Extension: Search pattern for extension numbers.
- Get Main Office Extensions: Include main office extensions? (Only branch / Branch + Main).
- Get Published: Filter by public directory status.
- Customer ID: Unique customer record ID.
- Limit: Number of rows to retrieve (required if using Offset).
- Name: Subject's name.
- Offset: Rows to skip (requires Limit).
Simplify Whether to simplify the output data. If enabled, only the property specified by "SimplifyPath" will be returned.
SimplifyPath Path to the property that should be returned when "Simplify" is enabled. Default: extensions_list.

Output

  • By default, the node returns the full JSON response from the PortaOne API for the "Get All Customer Extensions" request.
  • If Simplify is enabled, only the property specified by SimplifyPath (default: extensions_list) is returned.
  • The structure of the output typically includes an array of extension objects, each containing details such as extension number, name, status, and possibly more fields depending on the "Detailed Info" option.

Example output (simplified):

{
  "extensions_list": [
    {
      "extension": "1001",
      "name": "John Doe",
      "status": "active"
      // ...other fields
    },
    {
      "extension": "1002",
      "name": "Jane Smith",
      "status": "inactive"
      // ...other fields
    }
  ]
}
  • If binary data is ever returned (unlikely for this operation), it would represent exported files or similar content.

Dependencies

  • External Service: Requires access to a PortaOne API endpoint.
  • Authentication: Needs either a valid PortaOne API token or basic authentication credentials.
  • n8n Credentials: Must configure either "portaOneTokenApi" or "portaOneBasicApi" credentials in n8n, depending on the selected authentication method.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, ensure the correct credential type is selected and the credentials are valid.
  • Missing Required Fields: If using "Offset", "Limit" must also be set; otherwise, the API may reject the request.
  • Empty Results: If filters are too restrictive (e.g., non-existent Account ID or Extension), the result may be empty.
  • API Errors: Network issues or incorrect API endpoint configuration can cause errors.

Error messages and resolutions:

  • "Authentication failed" – Check your credentials and authentication method.
  • "Missing required parameter: limit" – Set the "Limit" field if using "Offset".
  • "Resource not found" – Verify the Customer ID or other filter values.

Links and References

Discussion