Poli icon

Poli

Node principal para interagir com a API da Poli

Overview

The node provides integration with the Poli API, allowing users to interact with various Poli resources such as apps, accounts, channels, messages, templates, contacts, tags, users, teams, and webhooks. Specifically, for the App resource with the List Apps operation, the node fetches a paginated list of applications associated with a given account.

This operation is useful when you want to retrieve all apps under a specific account, optionally filtering or ordering them, including additional related data fields, or querying with raw parameters. Practical examples include:

  • Listing all apps for an account to display in a dashboard.
  • Searching apps by name or other attributes.
  • Fetching detailed app information by including extra fields like roles, permissions, or metadata.

Properties

Name Meaning
Account UUID The unique identifier (UUID) of the account whose apps you want to list. This is required.
Options A collection of optional parameters to customize the listing:
- Search A search term to filter the apps by matching text.
- Order Defines the ordering of results, e.g., -created_at for descending creation date.
- Page The page number to fetch (pagination). Defaults to 1.
- Per Page Number of items per page to return. Defaults to 50.
- Include Additional related fields to include in the response. Possible values are: Status, Visibility, Attributes, Roles, Permissions, Attachments, Resources, Settings, Accounts, Metadata.
- Query Raw query string to pass custom filters, e.g., id=18&name=gabriel.

Output

The node outputs JSON data representing the list of apps retrieved from the Poli API. The structure typically includes an array of app objects, each containing standard app properties plus any additional included fields requested via the "Include" option.

If binary data were involved (not indicated here), it would be summarized accordingly, but this operation returns structured JSON data only.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Poli API.
  • The node depends on internal operation classes that handle the actual API calls for listing apps.
  • No external environment variables beyond the API credential are explicitly required.

Troubleshooting

  • Missing or invalid Account UUID: The operation requires a valid account identifier. Ensure the "Account UUID" property is set correctly; otherwise, the API call will fail.
  • Invalid options format: Passing incorrect types or malformed query strings in options may cause errors or unexpected results.
  • API authentication errors: If the API key credential is missing or invalid, the node will throw authentication errors.
  • Resource or Operation not found: Errors indicating unknown resource or operation suggest misconfiguration of the node's parameters.
  • Pagination issues: Requesting pages beyond available data may return empty results; verify page and perPage values.

To resolve errors, verify input parameters, ensure proper API credentials, and consult Poli API documentation for valid query parameters.

Links and References


Note: Internal code references and credential type names have been generalized to comply with guidelines.

Discussion