Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Overview
This node interacts with the AvantGuard Pax8 Partner API to fetch a paginated list of contacts associated with a specific company. It is useful when you need to retrieve contact information in manageable chunks, especially for companies with many contacts. Typical use cases include syncing contact data into CRMs, generating reports, or automating workflows that require up-to-date contact lists.
For example, you might use this node to:
- Retrieve the first 10 contacts of a company to display in a dashboard.
- Iterate through all pages of contacts to export them to another system.
- Filter contacts by page number and size to optimize API usage and performance.
Properties
| Name | Meaning |
|---|---|
| Company Id | The unique identifier of the company whose contacts you want to fetch. |
| Additional Query Parameters | Optional parameters to control pagination: - Page: The page number to request (default 0). - Size: Number of contacts per page (default 10). |
Output
The node outputs JSON data representing the list of contacts retrieved from the API. This typically includes an array of contact objects with their details such as name, email, phone, and other relevant fields defined by the API response schema.
If the API supports binary data for contacts (e.g., profile pictures), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON contact data only.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard Pax8 Partner API.
- The node uses the base URL
https://api.pax8.com/v1to make requests. - No additional external dependencies are indicated beyond the bundled OpenAPI client library.
Troubleshooting
- Invalid Company Id: If the company ID is incorrect or does not exist, the API may return an error or empty results. Verify the company ID before running the node.
- Pagination Issues: Requesting a page number beyond the available range may result in empty responses. Adjust the "Page" parameter accordingly.
- Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
- Rate Limits: The API may enforce rate limits; if exceeded, requests could fail temporarily. Implement retry logic or reduce request frequency.
- Network Errors: Check network connectivity and proxy settings if requests fail to reach the API endpoint.
Links and References
- AvantGuard Pax8 Partner API Documentation (general reference, actual docs should be consulted for detailed API specs)
- n8n documentation on Using API Credentials
- Pagination best practices in REST APIs: https://restfulapi.net/pagination/