Unipile icon

Unipile

Interact with Unipile API

Overview

This node operation allows you to list events from a specified calendar within an account. It is useful for retrieving scheduled events, filtering them by various criteria such as date ranges, attendees, status, and more. Typical use cases include syncing calendar events with other systems, generating reports of upcoming or past events, or automating workflows based on event data.

For example, you could use this node to:

  • Fetch all busy events in a team calendar for the next week.
  • Retrieve cancelled events to notify participants.
  • List events filtered by specific attendees or locations.

Properties

Name Meaning
Calendar ID The unique identifier of the calendar from which to list events.
Account ID The identifier of the account owning the calendar; used to scope the request.
Additional Filters A collection of optional filters to refine the event list:
- Attendees Comma-separated emails to filter events by attendee presence.
- Busy Boolean flag to filter events marked as busy.
- Cancelled Boolean flag to include cancelled events in the results.
- Cursor Pagination cursor for fetching subsequent pages of results.
- Description Filter events containing this text in their description.
- End Filter events that end before this date/time (ISO 8601 string).
- Event Type Comma-separated list of event types to filter by.
- Expand Recurring Boolean indicating whether to expand recurring events into individual occurrences.
- iCal UID Filter events by their iCal UID identifier.
- Limit Maximum number of events to return (minimum 1, default 50).
- Location Filter events by location text.
- Offset Pagination offset to skip a number of events.
- Start Filter events starting after this date/time (ISO 8601 string).
- Title Filter events by title text.
- Updated After Filter events updated after this date/time (ISO 8601 string).
- Updated Before Filter events updated before this date/time (ISO 8601 string).

Output

The output contains a JSON array of event objects matching the specified filters. Each event object typically includes details such as event title, start and end times, attendees, status, location, description, and identifiers like iCal UID.

If the node supports binary data output (not indicated here), it would represent attachments or related files associated with events, but this operation primarily returns structured JSON event data.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API service.
  • The node configuration must include the base URL (DSN) for the Unipile API endpoint.
  • Network connectivity to the Unipile API is necessary.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid Calendar ID or Account ID: Verify that the provided IDs exist and belong to the authenticated user/account.
  • Date format errors: Date filters must be in valid ISO 8601 string format; otherwise, the API may reject the request.
  • Pagination issues: Using incorrect cursor or offset values can result in empty or repeated results.
  • API rate limits: Excessive requests may trigger rate limiting; implement retries or backoff as needed.

Links and References

Discussion