List a profile's series
Returns series belonging to the specified profile.
path Parameters
profile_idPrefixed unique identifier of the profile (e.g., prf_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
query Parameters
cursorOpaque cursor returned from a previous list response.
limitMaximum number of items to return per page. Range 1-100, default 20.
List a profile's series › Responses
Page
has_morenext_cursorCreate series for a profile
Creates a series under a profile owned by the authenticated user. slug must be unique within the profile; conflicts return 409.
path Parameters
profile_idPrefixed unique identifier of the profile (e.g., prf_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
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 series for a profile › Request Body
nameslugdescriptionis_privateCreate series for a profile › Responses
Created
idnameslugdescriptionis_privatecreated_atupdated_atList series
Returns the series the authenticated caller can manage — those they own directly or administer through an organization they belong to. This is a workflow endpoint, not platform-wide discovery: public series owned by others are not returned. Use it to resolve a name to a series you can write to. Use listProfileSeries to scope to a single profile.
query Parameters
cursorOpaque cursor returned from a previous list response.
limitMaximum number of items to return per page. Range 1-100, default 20.
List series › Responses
Page
has_morenext_cursorRetrieve series
Returns a single series by ID.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Retrieve series › Responses
Series
idnameslugdescriptionis_privatecreated_atupdated_atDelete series
Deletes a series. By default, events that belong only to this series are preserved; pass cascade_exclusive_events=true to also delete them. Use previewSeriesDeletion first to see what would be removed.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
query Parameters
cascade_exclusive_eventsIf true, also delete events that belong only to this series. Events shared with other series are preserved.
Delete series › Responses
Deleted
member_countTotal events that were tagged in this series at delete time.
deleted_event_countEvents permanently deleted (only nonzero when cascade_exclusive_events=true).
preserved_event_countEvents that remain on the profile after deletion.
Update series
Updates fields on a series owned by the authenticated user. The slug is unique within the parent profile; conflicts return 409.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Update series › Responses
Updated
idnameslugdescriptionis_privatecreated_atupdated_atPreview series deletion
Returns a read-only preview of what deleteSeries would affect: the series itself, plus the list of events that would be removed if cascade_exclusive_events=true is passed. Does not modify anything.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Preview series deletion › Responses
Deletion impact summary
series_namemember_countTotal events tagged in this series.
exclusive_countEvents that would be deleted in cascade mode.
shared_countEvents that would be preserved (also tagged in other series).
List events in a series
Returns events in the specified series, ordered by start time.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
query Parameters
cursorOpaque cursor returned from a previous list response.
limitMaximum number of items to return per page. Range 1-100, default 20.
List events in a series › Responses
Page
has_morenext_cursorAdd event to series
Adds an existing event to the series. The event and series must both be owned by the authenticated user. Adding an event that is already in the series is a no-op.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
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.
Add event to series › Responses
Linked
Remove event from series
Removes the event-series link but does not delete the event itself. Inverse of addEventToSeries.
path Parameters
series_idPrefixed unique identifier of the series (e.g., ser_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
event_idPrefixed unique identifier of the event (e.g., evt_8f3ab21e49c44c8baf7b5e4a1b2c3d4e).
Remove event from series › Responses
Removed