Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Mailbox → List Of Mailbox

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Mailbox resource and the List Of Mailbox operation, it retrieves a list of mailboxes based on optional filtering criteria such as department, team, organization, or sender addresses.

Typical use cases include:

  • Fetching mailboxes associated with specific departments or teams within an organization.
  • Filtering mailboxes by sender addresses or other attributes.
  • Retrieving all mailboxes including or excluding default ones.
  • Automating mailbox management workflows by integrating mailbox data into broader business processes.

For example, a user might want to list all mailboxes belonging to a particular department to synchronize them with another system or to generate reports.

Properties

Name Meaning
Department Id Filter mailboxes by the ID of a specific department.
From Addresses Filter mailboxes by one or more sender email addresses.
Ignore Default Option to exclude default mailboxes from the results.
Organisation Id Filter mailboxes by the ID of a specific organisation.
Showall Option to include all mailboxes in the response, potentially overriding other filters.
Team Id Filter mailboxes by the ID of a specific team.

Output

The node outputs JSON data representing the list of mailboxes retrieved from the Halo PSA API. Each item in the output corresponds to a mailbox object containing its details as returned by the API.

If the operation encounters errors and "Continue On Fail" is enabled, the output will contain error messages in the json.error field for the respective input item.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant identifier, client ID, and client secret via credentials.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!: This error indicates missing or misconfigured API authentication credentials. Ensure that the required API key credential is properly set up in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Mailbox") and operation ("List Of Mailbox") names are used.
  • API request failures: Network issues, invalid parameters, or permission problems may cause API request errors. Check the error message returned in the output and verify API access rights and parameter correctness.
  • JSON parsing errors: If using advanced query or body parameters, ensure JSON strings are well-formed.

Enabling "Continue On Fail" allows the workflow to proceed even if some requests fail, providing error details in the output.

Links and References

Discussion