Overview

This node operation lists and searches users within a specified account using the Poli API. It is useful for retrieving user data based on various search criteria and options, such as search terms, ordering, pagination, and including additional related data. Practical examples include fetching a list of users for account management, filtering users by specific attributes, or retrieving detailed user information with related roles and permissions.

Use Case Examples

1. List all users in an account with default pagination.
2. Search users by name or email using a search term.
3. Retrieve users ordered by creation date.
4. Include additional user-related data such as roles, permissions, and account channels in the response.

Properties

Output

JSON

• users - Array of user objects matching the search and list criteria.
• pagination
  • page - Current page number of the results.
  • perPage - Number of users per page in the results.
  • total - Total number of users matching the criteria.

Dependencies

• Requires an API key credential for authenticating with the Poli API.

Troubleshooting

• Ensure the Account UUID is provided and valid; missing or incorrect UUID will cause errors.
• Verify that the search and query parameters are correctly formatted to avoid API errors.
• Check API authentication credentials if requests fail due to authorization issues.
• Handle pagination parameters carefully to avoid empty or incomplete results.