Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Sales Mailbox → Get One Sales Mailbox

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data related to various resources managed by Halo PSA. Specifically, for the Sales Mailbox resource and the Get One Sales Mailbox operation, it fetches detailed information about a single sales mailbox identified by its unique ID.

Typical use cases include:

  • Automating retrieval of specific sales mailbox details within workflows.
  • Integrating sales mailbox data into other systems or processes.
  • Validating access or configuration of sales mailboxes programmatically.

For example, you might use this node to get the configuration and status of a particular sales mailbox before processing incoming emails or routing them in your CRM system.

Properties

Name Meaning
Id The unique identifier (number) of the sales mailbox to retrieve.
Test Access Optional query parameter to test access; can be used to verify connectivity or permissions.
Includedetails Optional query parameter to specify whether to include detailed information in the response.

Output

The node outputs JSON data representing the sales mailbox object retrieved from the Halo PSA API. This includes all standard fields returned by the API for a single sales mailbox, potentially including metadata, configuration, and status information depending on the Includedetails parameter.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Main Sales Mailbox",
  "email": "sales@example.com",
  "status": "active",
  "details": { /* present if includedetails=true */ }
}

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects the following credential properties to be configured:
    • Base URL of the Halo PSA instance.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

These credentials must be set up in n8n prior to using the node.

Troubleshooting

  • No credentials returned!
    This error indicates that the required API authentication credentials are missing or not properly configured. Ensure that the API key credential is correctly set up in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Sales Mailbox") and operation ("Get One Sales Mailbox") names are selected.

  • HTTP request errors
    Errors during the API call may occur due to network issues, invalid parameters, or insufficient permissions. Check the API credentials, network connectivity, and parameter values such as the mailbox ID.

  • JSON parsing errors
    If additional JSON parameters are provided (not typical for this operation), ensure they are valid JSON strings.

Links and References

Discussion