Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Unsub Email Service Users → Get One Unsub Email Service Users

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about a single user from the "Unsub Email Service Users" resource. Specifically, it fetches details of one unsubscribed email service user by their unique identifier.

Common scenarios for this node include:

  • Retrieving detailed information about a specific unsubscribed user in an email service managed through Halo PSA.
  • Using the fetched data to verify or audit unsubscribed users before sending marketing or notification emails.
  • Integrating with workflows that manage email subscription statuses or compliance with email regulations.

For example, you might use this node to get the unsubscribe status and related metadata of a user identified by their ID, optionally including additional details if requested.

Properties

Name Meaning
Id The unique numeric identifier of the unsubscribed email service user to retrieve.
Includedetails Optional flag/query parameter to specify whether to include additional user details.

Output

The node outputs a JSON object representing the unsubscribed email service user data as returned by the Halo PSA API. This includes all standard fields associated with the user record.

If the Includedetails property is set, the output may contain extended information about the user.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "email": "user@example.com",
  "unsubscribedAt": "2024-01-01T12:00:00Z",
  "details": { /* optional additional details if included */ }
}

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests to the Halo PSA REST API.
  • No other external dependencies are required.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the Halo PSA API credentials are properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Unsub Email Service Users") and operation ("Get One Unsub Email Service Users") are selected.

  • Invalid or missing Id parameter
    The Id property is required and must be a valid number. Providing an invalid or missing ID will cause the request to fail.

  • API request errors
    Network issues, incorrect credentials, or API endpoint problems can cause request failures. Check the error message returned in the node output for details.

  • JSON parsing errors
    If using advanced parameters like JSON query or body parameters (not typical for this operation), ensure they are correctly formatted.

Links and References

Discussion