AvantGuard - Hudu icon

AvantGuard - Hudu

AvantGuard - Hudu
Join our community

Actions109

Overview

The Get Companies operation for the Companies resource retrieves a list of companies from an external service (presumably Hudu, via AvantGuard integration). This node is useful in scenarios where you need to fetch company records, possibly filtered by various criteria such as name, city, website, or other attributes. Practical applications include synchronizing company data with other systems, generating reports, or automating workflows that depend on up-to-date company information.

Properties

Name Type Meaning
Additional Query Parameters collection Optional set of filters and pagination controls for refining the list of returned companies.
└ Page number Retrieve the specified page of results.
└ Page Size number Specify the number of results to return per page.
└ Name string Filter companies by their name.
└ Phone Number string Filter companies by phone number.
└ Website string Filter companies by website.
└ City string Filter companies by city.
└ Id Number string Filter companies by id_number.
└ State string Filter companies by state.
└ Slug string Filter companies by URL slug.
└ Search string Filter companies by a search query.
└ Id In Integration string Filter companies by id/identifier in PSA/RMM/outside integration.
└ Updated At string Filter companies updated within a range or at an exact time.

Output

  • The output will be a JSON array of company objects.
  • Each object represents a company and contains fields corresponding to the company's details (such as name, phone number, website, city, etc.).
  • The exact structure of each company object depends on the API's response schema, but typically includes identifiers and descriptive fields relevant to a company.

Dependencies

  • External Service: Requires access to the Hudu API via AvantGuard.
  • API Key/Credentials: Needs valid credentials (avantguardHuduApi) configured in n8n.
  • Environment Variable: The base URL for the API must be set in the credentials as baseUrl.

Troubleshooting

  • Invalid Credentials: If the API key or base URL is incorrect, authentication errors will occur. Ensure credentials are correctly configured in n8n.
  • Missing Required Fields: If required query parameters are omitted or incorrectly formatted, the API may return errors or empty results.
  • Rate Limiting: Excessive requests may trigger rate limiting on the external API.
  • Common Error Messages:
    • 401 Unauthorized: Check your API credentials.
    • 404 Not Found: Verify the base URL and endpoint configuration.
    • 400 Bad Request: Review the query parameters for correct formatting and supported values.

Links and References

Discussion