AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation "Get Relations" retrieves a list of relations from an external service. It is useful when you need to fetch relational data, such as connections or associations between entities, typically for integration or data synchronization purposes. For example, you might use this node to get all related contacts linked to a customer record in a CRM system.

Properties

Name Meaning
Additional Query Parameters Optional parameters to customize the query. Includes:
- Page: Get the current page of results (number).
- Page Size: Number of results to return per page (number).

Output

The output contains a JSON field with the retrieved relations data structured as returned by the external API. This typically includes an array or collection of relation objects, each representing a single relation entity with its associated properties. The exact structure depends on the external service's response schema.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • The node uses a base URL configured via credentials to connect to the service endpoint.
  • No additional environment variables are explicitly required based on the provided code.

Troubleshooting

  • Empty or missing results: Ensure that the pagination parameters (page and page_size) are set correctly and that the external service has data available.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Invalid parameter errors: Check that the additional query parameters are numbers and within acceptable ranges.
  • Network or connectivity issues: Confirm that the base URL is correct and accessible from the n8n instance.

Links and References

  • Refer to the external service's API documentation for detailed information about the "relations" resource and supported query parameters.
  • n8n documentation on how to configure API credentials and use query parameters in nodes.

Discussion