Poli icon

Poli

Node principal para interagir com a API da Poli

Actions22

Overview

This node interacts with the Poli API to list and search contacts within a specified account. It allows users to retrieve contact information filtered by various criteria, sorted, paginated, and enriched with additional related data fields. This is useful for scenarios such as managing customer databases, performing targeted marketing campaigns, or integrating contact data into workflows.

Practical examples include:

  • Retrieving a paginated list of contacts from an account.
  • Searching contacts by name or other text fields.
  • Sorting contacts by creation date or other attributes.
  • Including extra details like tags, addresses, or chat status in the response.

Properties

Name Meaning
Account ID The unique identifier of the account whose contacts you want to list. This is required.
Options A collection of optional parameters to refine the contact listing:
- Search: Text string to search contacts by.
- Query: Raw query string for advanced filtering (e.g., id=18&name=gabriel).
- Order: Field and direction for sorting results (e.g., created_at desc).
- Page: Page number for pagination (minimum 1).
- Per Page: Number of items per page (1 to 100).
- Include: Additional related fields to include in the response. Possible values:
  • Type
  • Chat Status
  • Read Status
  • Attributes
  • Account
  • Attendant
  • Contact Channels
  • Current Attendance
  • Last Message
  • Tags
  • Addresses
  • Metadata

Output

The node outputs JSON data representing the list of contacts retrieved from the Poli API. Each contact object includes standard contact fields and may include additional related data if requested via the "Include" options. The output structure typically contains:

  • An array of contact objects with their properties.
  • Pagination metadata such as current page, total pages, and total items (if provided by the API).

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Poli API using an API key credential configured in n8n.
  • The node depends on the Poli API service being available and accessible.
  • Proper permissions on the Poli account are necessary to list contacts.

Troubleshooting

  • Common issues:

    • Missing or invalid Account ID will cause the request to fail.
    • Incorrect query syntax in the raw query string can lead to errors or empty results.
    • Requesting too many items per page (above 100) may be rejected.
    • Network or authentication errors if the API key is invalid or expired.

  • Error messages:

    • "Resource 'contact' not found": Indicates the resource parameter is incorrect or missing.
    • "Operation 'list' not found for resource 'contact'": Means the operation parameter is invalid.
    • API errors related to authorization or rate limits should be resolved by checking credentials and API usage policies.

Links and References

Discussion