Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Sage Business Cloud Details → List Of Sage Business Cloud Details

AI-generated

Overview

This node integrates with the Sage Business Cloud Details API to retrieve a list of business cloud details. It is designed to fetch information about connected tenants or specific tenant details based on input parameters. This node is useful in scenarios where you need to automate the retrieval of tenant-related data from Sage Business Cloud, such as syncing tenant information into your CRM, auditing connected accounts, or managing multiple tenants programmatically.

Practical examples include:

  • Listing all connected tenants filtered by connection status.
  • Retrieving details for a specific tenant by providing its tenant ID.

Properties

Name Meaning
Connectedonly Filter to return only tenants that are currently connected. Possible values depend on API but typically boolean or similar.
Tenantid The unique identifier of a tenant to retrieve details for.

Output

The node outputs an array of JSON objects representing the Sage Business Cloud details retrieved from the API. Each item corresponds to one tenant's details or a filtered list of tenants depending on the input parameters.

If binary data were involved (not indicated here), it would be included in the binary property, but this node focuses on JSON data output.

Example output structure (simplified):

[
  {
    "tenantId": "string",
    "name": "string",
    "connected": true,
    "otherDetails": { /* additional tenant-specific fields */ }
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Sage Business Cloud API.
  • The node expects proper configuration of credentials including base URL and authentication tokens.
  • Network access to the Sage Business Cloud API endpoint is necessary.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured and assigned to the node.

  • Resource or Operation not found
    Indicates that the specified resource or operation name does not match any known API endpoints. Verify that the Resource is set to "Sage Business Cloud Details" and Operation to "List Of Sage Business Cloud Details".

  • API request errors
    Errors returned from the API (e.g., authentication failure, invalid parameters) will be surfaced in the node output under an error field if "Continue On Fail" is enabled. Check the error message for details and verify input parameters and credentials.

  • Invalid JSON in parameters
    If using JSON parameters, ensure they are correctly formatted to avoid parsing errors.

Links and References

Note: The above summary is based solely on static analysis of the provided source code and input properties.

Discussion