AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

This node operation "Find Companies" allows users to retrieve a list of companies from an external service with flexible filtering and pagination options. It is useful in scenarios where you need to query company data based on specific criteria such as location, status, or feature flags. For example, you might use it to fetch all active companies located in a particular city or to paginate through large sets of company records sorted by name.

Properties

Name Meaning
Additional Query Parameters Optional filters and controls for the query including:
- Page The page number to request in the companies list (number).
- Size Number of company records to return per page (number).
- Sort Field and direction to sort results by. Options: Name, City, Country, State Or Province, Postal Code.
- City Filter companies matching this city (string).
- Country Filter companies matching this country (string).
- State Or Province Filter companies matching this state or province (string).
- Postal Code Filter companies matching this postal code (string).
- Self Service Allowed Filter companies where self-service is allowed (boolean).
- Bill On Behalf Of Enabled Filter companies where billing on behalf of others is enabled (boolean).
- Order Approval Required Filter companies requiring order approval (boolean).
- Status Filter companies by status. Options: Active, Inactive, Deleted.

Output

The node outputs JSON data containing the list of companies that match the specified query parameters. Each item in the output typically represents a company object with its associated details as returned by the external API. There is no indication of binary data output for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external Pax8 Partner API.
  • The base URL for API requests is https://api.pax8.com/v1.
  • The node expects JSON responses and sends requests with appropriate headers (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will result in authentication errors.
    • Providing invalid query parameter values (e.g., non-numeric page or size) may cause request failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:
    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on query parameters suggest checking the input types and allowed values.
    • Rate limiting or server errors from the API should be handled by retrying after some delay.

Links and References

Discussion