List subscriptions
Returns the authenticated user's active and inactive subscriptions to profiles or series.
query Parameters
cursorOpaque cursor returned from a previous list response.
limitMaximum number of items to return per page. Range 1-100, default 20.
List subscriptions › Responses
Page
has_morenext_cursorCreate subscription
Subscribes the authenticated user to a profile or series. The corresponding events are then synced into target_calendar_id (or the user's default personal calendar if omitted).
Headers
Idempotency-KeyA client-generated identifier (UUIDv4 recommended; 8–255 chars, alphanumeric/underscore/hyphen) for the request. The header is validated and logged, but server-side deduplication is not enforced: resubmitting a create with the same key produces a second resource. Treat creates as non-idempotent and design retries accordingly. Deduplication is planned for a future API version.
Create subscription › Request Body
subscription_typeprofile_idseries_idtarget_calendar_idinclude_personal_calendarsync_window_startsync_window_endCreate subscription › Responses
Created
idsubscription_typeis_activeaccess_validinclude_personal_calendarsync_window_startsync_window_endcreated_atupdated_atRetrieve subscription
Returns a subscription owned by the authenticated user.
path Parameters
subscription_idPrefixed unique identifier of the subscription (e.g., sub_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Retrieve subscription › Responses
Subscription
idsubscription_typeis_activeaccess_validinclude_personal_calendarsync_window_startsync_window_endcreated_atupdated_atDelete subscription
Unsubscribes from the source. Events that were synced under this subscription are removed from the target calendar.
path Parameters
subscription_idPrefixed unique identifier of the subscription (e.g., sub_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Delete subscription › Responses
Deleted
Update subscription
Updates a subscription's sync window or active state. Setting is_active: false stops new events from syncing but does not retroactively remove events that were already synced.
path Parameters
subscription_idPrefixed unique identifier of the subscription (e.g., sub_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Update subscription › Request Body
is_activesync_window_startsync_window_endUpdate subscription › Responses
Updated
idsubscription_typeis_activeaccess_validinclude_personal_calendarsync_window_startsync_window_endcreated_atupdated_at