Unipile icon

Unipile

Interact with Unipile API
Join our community

Actions85

Overview

The node interacts with the Unipile API, specifically allowing users to list accounts when using the "Account" resource with the "List Accounts" operation. This operation fetches a list of account records from Unipile, supporting pagination and limiting the number of results returned.

This node is beneficial in scenarios where you need to retrieve multiple account entries for further processing, such as syncing account data, generating reports, or integrating account information into other workflows.

Example use cases:

  • Fetching a paginated list of user accounts to display in a dashboard.
  • Retrieving a limited set of accounts for batch processing or analysis.
  • Integrating account data from Unipile into CRM or marketing automation tools.

Properties

Name Meaning
Additional Fields Optional parameters to customize the request:
- Cursor A string cursor used for pagination to continue fetching results from a specific point.
- Limit Maximum number of account results to return (minimum 1, default 50).

Output

The node outputs JSON data containing the list of accounts retrieved from the Unipile API. The structure typically includes an array of account objects with their respective details as provided by the API response.

If the API supports binary data for accounts (not indicated here), it would be included accordingly, but based on the code and properties, the output is primarily JSON-formatted account data.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is dynamically set from the credential's DSN (Data Source Name).
  • The node sends HTTP requests with headers specifying JSON content type and acceptance.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Providing an invalid cursor value may result in errors or empty responses.
    • Setting the limit below 1 may cause validation errors.
  • Error messages:
    • Authentication errors indicate problems with the API key or DSN configuration.
    • Pagination errors may occur if the cursor is malformed or expired.
  • Resolutions:
    • Verify that the API key credential is correctly configured and active.
    • Ensure the cursor value is obtained from a previous successful response.
    • Use valid numeric values for the limit property within allowed ranges.

Links and References

Discussion