Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to list invitations received by a user account. It is designed to retrieve and paginate through invitations sent to a specific user account within the Unipile platform. This operation is useful in scenarios where you want to monitor or manage incoming invitations programmatically, such as automating invitation handling workflows or integrating invitation data into other systems.

Practical examples include:

  • Automatically fetching new invitations for a user to trigger notifications.
  • Aggregating invitation data for reporting or analytics.
  • Integrating invitation lists into CRM or communication tools.

Properties

Name Meaning
Account ID The unique identifier of the user account whose received invitations are to be listed.
Additional Fields Optional parameters to refine the request:
- Cursor A pagination cursor to fetch the next set of results.
- Limit Maximum number of invitations to return in one response (minimum 1, default 50).

Output

The output JSON contains a list of invitation objects representing the invitations received by the specified user account. Each invitation object typically includes details such as sender information, invitation status, timestamps, and any relevant metadata provided by the Unipile API.

If the API supports pagination, the output may also include pagination cursors or tokens to retrieve subsequent pages of invitations.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Unipile API via an API key credential.
  • The node expects the base URL for the Unipile API to be configured in the credentials.
  • Proper permissions on the API key to access user invitation data are necessary.

Troubleshooting

  • Missing or invalid Account ID: Ensure that the Account ID is provided and correctly formatted; otherwise, the API will reject the request.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Pagination issues: If using the cursor for pagination, ensure it is correctly passed from previous responses; invalid cursors may cause errors or empty results.
  • Rate limiting or network errors: Handle API rate limits gracefully and check network connectivity if requests fail.

Links and References

Discussion