Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Email Store → Get One Email Store

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about email stores. Specifically, the "Get One Email Store" operation fetches details of a single email store by its unique identifier. This is useful in scenarios where you need to access or verify specific email store configurations within your PSA system, such as for auditing, reporting, or further automation workflows involving email data.

Practical examples include:

  • Fetching an email store's configuration before processing emails.
  • Validating the existence and details of an email store before performing updates or deletions.
  • Integrating email store data into dashboards or notifications.

Properties

Name Meaning
Id The unique numeric identifier of the email store to retrieve.
Includedetails Optional flag/query parameter to specify whether to include detailed information in the response.

Output

The node outputs JSON data representing the retrieved email store object from the Halo PSA API. The structure corresponds to the API's response for a single email store, typically including fields like the store's ID, name, configuration details, and possibly other metadata depending on the includedetails parameter.

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 the following credentials/configuration parameters:
    • Base URL of the Halo PSA API instance.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

These must be configured in n8n prior to using the node.

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 ("Email Store") and operation ("Get One Email Store") are selected.

  • API request errors
    Network issues, invalid IDs, or permission problems may cause API request failures. Check the provided email store ID is valid and that the API credentials have sufficient permissions.

  • JSON parsing errors
    If additional query parameters or JSON bodies are used incorrectly, parsing errors might occur. For this operation, ensure the Id is a valid number and Includedetails (if used) is correctly formatted.

Links and References

Discussion