Overview

This node interacts with the Poli API to list accounts. It is useful for retrieving a list of accounts with various filtering and pagination options. For example, users can search for accounts by text, order the results, specify the page number and number of results per page, and include additional related data such as status, attributes, organization, account channels, addresses, applications, and metadata.

Use Case Examples

1. Retrieve a list of accounts with a search term to find specific accounts.
2. List accounts ordered by a certain field and paginate through the results.
3. Include related data like organization and account channels in the account list response.

Properties

Output

JSON

• accounts - List of accounts retrieved from the Poli API, including any requested related data.

Dependencies

• Poli API with appropriate API key credentials

Troubleshooting

• Ensure the API credentials are correctly configured and have permission to access account data.
• Verify that the 'resource' parameter is set to 'account' and the 'operation' parameter is set to 'list'.
• Check the format of the 'query' string if used, to ensure it is valid and correctly encoded.
• Common errors include missing or invalid parameters, API authentication failures, and network connectivity issues. These can be resolved by verifying input parameters, credentials, and network status.

Links

• Poli API Accounts Documentation - Official documentation for the Poli API accounts endpoint, detailing available query parameters and response structure.