Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Mailbox → Get One Mailbox

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific mailbox. It is designed to fetch one mailbox by its unique identifier, optionally including additional details and global SMTP settings. This node is useful in scenarios where you need to programmatically access mailbox configurations within Halo PSA for automation, reporting, or synchronization purposes.

Practical examples:

  • Automatically retrieving mailbox settings before sending emails through Halo PSA.
  • Synchronizing mailbox configurations with other systems.
  • Auditing mailbox details including SMTP settings for compliance or troubleshooting.

Properties

Name Meaning
Id The unique numeric identifier of the mailbox to retrieve.
Includedetails Optional flag/query parameter to include detailed information about the mailbox.
Includeglobalsmtp Optional flag/query parameter to include global SMTP settings related to the mailbox.

Output

The node outputs a JSON object representing the mailbox data retrieved from the Halo PSA API. The structure includes all standard mailbox fields and, depending on input parameters, may also contain detailed mailbox information and global SMTP configuration.

If the optional flags are set, the output JSON will be enriched with:

  • Detailed mailbox properties.
  • Global SMTP settings applicable to the mailbox.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials containing base URL, tenant identifier, client ID, and client secret for authentication.
  • The node expects these credentials to be configured in n8n prior to execution.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node throws an error "No credentials returned!". Ensure that valid API credentials are configured.
  • Resource or Operation Not Found: Errors like Resource Mailbox not found or Operation Get One Mailbox not found for resource Mailbox indicate misconfiguration of resource or operation names.
  • Invalid Id Parameter: Since the mailbox ID is required, providing an invalid or missing ID will cause the request to fail.
  • API Request Failures: Network issues, incorrect base URL, or insufficient permissions can cause API call failures. Check connectivity and credential permissions.
  • JSON Parsing Errors: If additional query parameters or request bodies are malformed JSON, parsing errors may occur.

To resolve these issues:

  • Verify credentials and their permissions.
  • Confirm the mailbox ID exists in Halo PSA.
  • Check network connectivity and API endpoint correctness.
  • Use the "Continue On Fail" option to handle errors gracefully during batch processing.

Links and References

Discussion