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 users within a specified account. It is useful for scenarios where you need to retrieve user information from an account, optionally filtering or sorting the results, paginating through large datasets, or including additional related data fields.

Practical examples include:

  • Fetching all users of a particular account to display in a dashboard.
  • Searching users by name or other criteria.
  • Retrieving detailed user information including roles, permissions, and associated teams.
  • Paginating through users when there are many entries.

Properties

Name Meaning
Account UUID UUID of the account for which to list users. This is required to specify the target account.
Options Collection of optional parameters to refine the user listing:
- Search Term to search users by (e.g., part of a name or email).
- Order Sorting order of the results (e.g., ascending or descending by a field).
- Page Page number for pagination (default is 1).
- Per Page Number of results per page (default is 100).
- Query Raw query string to filter users (e.g., id=18&name=gabriel).
- Include Additional related data to include in the response. Possible values: Status, Status of Service, Email, Attributes, Roles, Permissions, Active Account, Account Channels, Accounts, Teams, Addresses, Metadata.

Output

The node outputs JSON data representing the list of users retrieved from the Poli API according to the specified filters and options. The structure typically includes user details such as identifiers, names, emails, statuses, roles, and any additional included data requested via the "Include" option.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON user data.

Dependencies

  • Requires an API key credential for authenticating with the Poli API.
  • The node depends on the Poli API service being accessible and properly configured.
  • No additional external dependencies beyond the Poli API and its authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Account UUID will cause the request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Using unsupported or malformed query strings may lead to API errors.
    • Requesting pages beyond available data will return empty results.

  • Error messages:

    • "Resource 'user' não encontrado": The resource parameter was not recognized; ensure "User" is selected.
    • "Operação 'list' não encontrada para o resource 'user'": The operation is invalid for the User resource; verify operation selection.
    • Authentication errors indicate problems with the API key or token; reconfigure credentials.
    • API rate limits or network errors should be handled by retrying after some time.

Links and References

Discussion