Unipile icon

Unipile

Interact with Unipile API

Overview

This node interacts with the Unipile API to list user relations associated with a specific account. It is useful for scenarios where you need to retrieve connections or relationships of users within an account, such as fetching contacts, collaborators, or linked profiles. For example, a marketing automation workflow might use this node to gather all related users before sending targeted communications.

Properties

Name Meaning
Account ID The unique identifier of the account whose user relations you want to list.
Additional Fields Optional parameters to refine the query:
- Cursor A pagination cursor to fetch the next set of results.
- Filter A string to filter user relations by user name.
- Limit Maximum number of results to return (minimum 1, default 50).

Output

The node outputs JSON data representing the list of user relations retrieved from the Unipile API. Each item in the output typically contains details about a related user, such as their identifiers and metadata. The exact structure depends on the API response but generally includes user relation attributes.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via the node credentials.
  • No additional external dependencies are required.

Troubleshooting

  • Missing or invalid Account ID: Ensure the Account ID is provided and correctly formatted; otherwise, the API call will fail.
  • API authentication errors: Verify that the API key credential is valid and has necessary permissions.
  • Pagination issues: When using the Cursor field, ensure it is correctly obtained from previous responses to paginate results properly.
  • Filter syntax: Incorrect filter strings may result in empty or error responses; check the API documentation for supported filter formats.
  • Limit value: Setting the limit below 1 will be rejected; use values 1 or higher.

Links and References

Discussion