Series

Available Methods

Method	HTTP	Path	Description
`acceptManagerInvite`	POST	`/api/v1/series/accept-manager-invite`	Accept series manager invite
`listPendingManagerInvites`	GET	`/api/v1/series/pending-manager-invites`	List pending series manager invites
`getByID`	GET	`/api/v1/series/{id}`	Get series by ID with all occurrences
`listAttendees`	GET	`/api/v1/series/{id}/attendees`	List series attendees
`addAttendee`	POST	`/api/v1/series/{id}/attendees`	Add attendee to series
`bulkAddAttendees`	POST	`/api/v1/series/{id}/attendees/bulk`	Bulk add attendees to series
`removeAttendee`	DELETE	`/api/v1/series/{id}/attendees/{contact_id}`	Remove attendee from series
`updateAttendeeStatus`	PATCH	`/api/v1/series/{id}/attendees/{contact_id}`	Update series attendee status
`checkInAttendee`	POST	`/api/v1/series/{id}/attendees/{contact_id}/check-in`	Check in a series attendee
`listDocuments`	GET	`/api/v1/series/{id}/documents`	List documents linked to series
`removeDocument`	DELETE	`/api/v1/series/{id}/documents/{document_id}`	Unlink document from series
`addDocument`	POST	`/api/v1/series/{id}/documents/{document_id}`	Link document to series
`listLinks`	GET	`/api/v1/series/{id}/links`	List cross-reference links for series
`addLink`	POST	`/api/v1/series/{id}/links`	Link event to series
`removeLink`	DELETE	`/api/v1/series/{id}/links/{target_id}`	Remove cross-reference link from series
`listMilestones`	GET	`/api/v1/series/{id}/milestones`	List series milestones
`addMilestone`	POST	`/api/v1/series/{id}/milestones`	Add milestone to series
`removeMilestone`	DELETE	`/api/v1/series/{id}/milestones/{milestone_event_id}`	Remove milestone from series
`patchMilestoneLifecycle`	PATCH	`/api/v1/series/{id}/milestones/{milestone_event_id}`	Update series milestone lifecycle
`updateMilestone`	PUT	`/api/v1/series/{id}/milestones/{milestone_event_id}`	Update series milestone sequence

`acceptManagerInvite`

Accept series manager invite POST /api/v1/series/accept-manager-invite Signature: lb.series.acceptManagerInvite({ body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`token`	body	string	✓	Invite token

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`address`	string	Venue address
`cover_image_key`	string	Canonical cover image storage key
`created_at`	string (date-time)	Created timestamp
`creator_id`	string	Profile ID of the creator
`description`	string	Canonical series description
`duration`	string	Duration of each occurrence as a Postgres interval string
`end_count`	integer	Max number of occurrences including anchor (used when ends_on=after_n)
`end_date`	string (date-time)	Last allowed start date (used when ends_on=on_date)
`end_dt`	string (date-time)	Canonical end datetime
`ends_on`	`"never"`	`"on_date"`	`"after_n"`	How the series ends
`freq`	`"daily"`	`"weekly"`	`"monthly"`	`"custom"`	Recurrence frequency
`id`	integer	Series ID
`interval`	integer	Repeat every N units of freq (e.g. 2 = every 2 weeks)
`is_deleted`	boolean	Soft-deleted flag
`keywords`	[‘array’, ‘null’]	Search keywords
`latitude`	number	Venue latitude
`longitude`	number	Venue longitude
`metadata`	object	Canonical series metadata (theme, cover, etc.)
`org_id`	string	Organization ID (nil for personal events)
`published_at`	string (date-time)	When the series was most recently published
`published_id`	integer	ID of the published version (if currently a draft)
`repeat_days`	[‘array’, ‘null’]	ISO weekdays to repeat on [1-7]; used for weekly/custom freq
`series_manager_accepted_at`	string (date-time)	When invite was accepted
`series_manager_expires_at`	string (date-time)	When invite expires
`series_manager_id`	string	Profile ID of the series manager (active)
`series_manager_invite_token`	string	Invite token for pending manager
`series_manager_invited_at`	string (date-time)	When invite was sent
`series_manager_invited_by`	string	Profile ID who sent invite
`series_manager_invited_email`	string	Email of invitee
`series_manager_status`	string	Manager status: pending, active, revoked
`start_dt`	string (date-time)	Canonical start datetime
`status`	`"draft"`	`"published"`	`"archived"`	Publish status: draft, published, archived
`template`	string	Event template id; every occurrence inherits this.
`template_version`	integer	Schema version of the chosen template.
`timezone`	string	IANA timezone for canonical occurrence
`title`	string	Canonical series title (master event name)
`updated_at`	string (date-time)	Updated timestamp
`version`	integer	Version number (incremented on each publish)
`visibility`	integer	Visibility: 10=private, 20=members-only, 30=organization, 40=public

`listPendingManagerInvites`

List pending series manager invites GET /api/v1/series/pending-manager-invites Signature: lb.series.listPendingManagerInvites() No parameters. Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`items`	[‘array’, ‘null’]

`getByID`

Get series by ID with all occurrences GET /api/v1/series/{id} Signature: lb.series.getByID({ path: \{ id \}, query?: \{ page, limit \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`page`	query	integer		Page number for occurrences (1-based)
`limit`	query	integer		Occurrences per page

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`attendee_counts`	object	Attendee counts by status
`limit`	integer	Page size
`occurrences`	[‘array’, ‘null’]	Occurrence events for the current page
`page`	integer	Current page (1-based)
`series`	object
`total`	integer	Total number of occurrences
`total_attendees`	integer	Total unique attendees
`total_pages`	integer	Total number of pages

`listAttendees`

List series attendees GET /api/v1/series/{id}/attendees Signature: lb.series.listAttendees({ path: \{ id \}, query?: \{ page, size \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`page`	query	integer		Page number (1-based)
`size`	query	integer		Items per page

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`items`	[‘array’, ‘null’]	List of results
`page`	integer	Current page (1-based)
`size`	integer	Page size
`total`	integer	Total matching records

`addAttendee`

Add attendee to series POST /api/v1/series/{id}/attendees Signature: lb.series.addAttendee({ path: \{ id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`contact_id`	body	string	✓	Contact UUID
`notes`	body	string		Optional notes
`status`	body	`"invited"`	`"confirmed"`	`"declined"`	`"tentative"`	`"checked_in"`	Initial status

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`checked_in_at`	string (date-time)	Check-in time
`contact_id`	string	Contact UUID
`created_at`	string (date-time)	Created timestamp
`event_id`	integer	Event ID (when attending a specific occurrence)
`function`	string	The capacity in which this person attends — e.g. ‘patient’, ‘provider’, ‘speaker’, ‘host’. Template-driven; nil for gene
`id`	integer	Attendee record ID
`invited_at`	string (date-time)	When invited
`is_checked_in`	boolean	Whether checked in
`notes`	string	Optional notes
`org_id`	string	Organization ID
`responded_at`	string (date-time)	When responded
`series_id`	integer	Series ID (when attending all occurrences in a series)
`status`	`"invited"`	`"confirmed"`	`"declined"`	`"tentative"`	`"checked_in"`	Attendance status
`updated_at`	string (date-time)	Updated timestamp

`bulkAddAttendees`

Bulk add attendees to series POST /api/v1/series/{id}/attendees/bulk Signature: lb.series.bulkAddAttendees({ path: \{ id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`contact_ids`	body	[‘array’, ‘null’]	✓	List of contact UUIDs
`status`	body	`"invited"`	`"confirmed"`	`"declined"`	`"tentative"`	`"checked_in"`	Attendance status

`removeAttendee`

Remove attendee from series DELETE /api/v1/series/{id}/attendees/{contact_id} Signature: lb.series.removeAttendee({ path: \{ id, contact_id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`contact_id`	path	string	✓	Contact UUID

`updateAttendeeStatus`

Update series attendee status PATCH /api/v1/series/{id}/attendees/{contact_id} Signature: lb.series.updateAttendeeStatus({ path: \{ id, contact_id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`contact_id`	path	string	✓	Contact UUID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`status`	body	`"invited"`	`"confirmed"`	`"declined"`	`"tentative"`	`"checked_in"`	✓	New status

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`checked_in_at`	string (date-time)	Check-in time
`contact_id`	string	Contact UUID
`created_at`	string (date-time)	Created timestamp
`event_id`	integer	Event ID (when attending a specific occurrence)
`function`	string	The capacity in which this person attends — e.g. ‘patient’, ‘provider’, ‘speaker’, ‘host’. Template-driven; nil for gene
`id`	integer	Attendee record ID
`invited_at`	string (date-time)	When invited
`is_checked_in`	boolean	Whether checked in
`notes`	string	Optional notes
`org_id`	string	Organization ID
`responded_at`	string (date-time)	When responded
`series_id`	integer	Series ID (when attending all occurrences in a series)
`status`	`"invited"`	`"confirmed"`	`"declined"`	`"tentative"`	`"checked_in"`	Attendance status
`updated_at`	string (date-time)	Updated timestamp

`checkInAttendee`

Check in a series attendee POST /api/v1/series/{id}/attendees/{contact_id}/check-in Signature: lb.series.checkInAttendee({ path: \{ id, contact_id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓
`contact_id`	path	string	✓
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.

`listDocuments`

List documents linked to series GET /api/v1/series/{id}/documents Signature: lb.series.listDocuments({ path: \{ id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID

Returns: Response: ['array', 'null']

`removeDocument`

Unlink document from series DELETE /api/v1/series/{id}/documents/{document_id} Signature: lb.series.removeDocument({ path: \{ id, document_id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`document_id`	path	string	✓	Document UUID

`addDocument`

Link document to series POST /api/v1/series/{id}/documents/{document_id} Signature: lb.series.addDocument({ path: \{ id, document_id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`document_id`	path	string	✓	Document UUID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.

Returns: Response: Created

`listLinks`

List cross-reference links for series GET /api/v1/series/{id}/links Signature: lb.series.listLinks({ path: \{ id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID

Returns: Response: ['array', 'null']

`addLink`

Link event to series POST /api/v1/series/{id}/links Signature: lb.series.addLink({ path: \{ id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`target_id`	body	integer	✓	Target event ID to link

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`created_at`	string (date-time)	Created timestamp
`event_id`	integer	Source event ID
`id`	integer	Link ID
`series_id`	integer	Series ID (when link applies to all occurrences)
`target_id`	integer	Target event ID

`removeLink`

Remove cross-reference link from series DELETE /api/v1/series/{id}/links/{target_id} Signature: lb.series.removeLink({ path: \{ id, target_id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`target_id`	path	integer	✓	Target event ID to unlink

`listMilestones`

List series milestones GET /api/v1/series/{id}/milestones Signature: lb.series.listMilestones({ path: \{ id \}, query?: \{ page, size \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`page`	query	integer		Page number (1-based)
`size`	query	integer		Items per page

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`items`	[‘array’, ‘null’]	List of results
`page`	integer	Current page (1-based)
`size`	integer	Page size
`total`	integer	Total matching records

`addMilestone`

Add milestone to series POST /api/v1/series/{id}/milestones Signature: lb.series.addMilestone({ path: \{ id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`milestone_event_id`	body	integer	✓	Event ID to use as milestone
`sequence`	body	integer		Display order (defaults to 0)

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`base_event_id`	integer	Base event ID
`created_at`	string (date-time)	Created timestamp
`id`	integer	Record ID
`milestone_event_id`	integer	Milestone event ID
`sequence`	integer	Display order
`series_id`	integer	Series ID (when milestone applies to all occurrences)
`status`	`"planned"`	`"ready"`	`"active"`	`"completed"`	`"skipped"`	Milestone lifecycle status
`status_mode`	`"derived"`	`"manual"`	How milestone status is controlled
`status_updated_at`	string (date-time)	When lifecycle status was last recalculated or manually changed
`updated_at`	string (date-time)	Updated timestamp

`removeMilestone`

Remove milestone from series DELETE /api/v1/series/{id}/milestones/{milestone_event_id} Signature: lb.series.removeMilestone({ path: \{ id, milestone_event_id \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`milestone_event_id`	path	integer	✓	Milestone Event ID

`patchMilestoneLifecycle`

Update series milestone lifecycle PATCH /api/v1/series/{id}/milestones/{milestone_event_id} Signature: lb.series.patchMilestoneLifecycle({ path: \{ id, milestone_event_id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`milestone_event_id`	path	integer	✓	Milestone Event ID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`reset_to_derived`	body	boolean		Reset milestone lifecycle back to date-driven automatic mode
`status`	body	`"planned"`	`"ready"`	`"active"`	`"completed"`	`"skipped"`	New manual lifecycle status

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`base_event_id`	integer	Base event ID
`created_at`	string (date-time)	Created timestamp
`id`	integer	Record ID
`milestone_event_id`	integer	Milestone event ID
`sequence`	integer	Display order
`series_id`	integer	Series ID (when milestone applies to all occurrences)
`status`	`"planned"`	`"ready"`	`"active"`	`"completed"`	`"skipped"`	Milestone lifecycle status
`status_mode`	`"derived"`	`"manual"`	How milestone status is controlled
`status_updated_at`	string (date-time)	When lifecycle status was last recalculated or manually changed
`updated_at`	string (date-time)	Updated timestamp

`updateMilestone`

Update series milestone sequence PUT /api/v1/series/{id}/milestones/{milestone_event_id} Signature: lb.series.updateMilestone({ path: \{ id, milestone_event_id \}, body: \{ ... \} }) Parameters:

Parameter	In	Type	Required	Description
`id`	path	integer	✓	Series ID
`milestone_event_id`	path	integer	✓	Milestone Event ID
`$schema`	body	string (uri)		A URL to the JSON Schema for this object.
`sequence`	body	integer	✓	New display order

Returns:

Field	Type	Description
`$schema`	string (uri)	A URL to the JSON Schema for this object.
`base_event_id`	integer	Base event ID
`created_at`	string (date-time)	Created timestamp
`id`	integer	Record ID
`milestone_event_id`	integer	Milestone event ID
`sequence`	integer	Display order
`series_id`	integer	Series ID (when milestone applies to all occurrences)
`status`	`"planned"`	`"ready"`	`"active"`	`"completed"`	`"skipped"`	Milestone lifecycle status
`status_mode`	`"derived"`	`"manual"`	How milestone status is controlled
`status_updated_at`	string (date-time)	When lifecycle status was last recalculated or manually changed
`updated_at`	string (date-time)	Updated timestamp

Getting Started

Events

Spaces

Users & Organizations

Automation

Bookings & Contacts

Analytics

Places

Utilities

Other

Available Methods

`acceptManagerInvite`

`listPendingManagerInvites`

`getByID`

`listAttendees`

`addAttendee`

`bulkAddAttendees`

`removeAttendee`

`updateAttendeeStatus`

`checkInAttendee`

`listDocuments`

`removeDocument`

`addDocument`

`listLinks`

`addLink`

`removeLink`

`listMilestones`

`addMilestone`

`removeMilestone`

`patchMilestoneLifecycle`

`updateMilestone`

​Available Methods

​acceptManagerInvite

​listPendingManagerInvites

​getByID

​listAttendees

​addAttendee

​bulkAddAttendees

​removeAttendee

​updateAttendeeStatus

​checkInAttendee

​listDocuments

​removeDocument

​addDocument

​listLinks

​addLink

​removeLink

​listMilestones

​addMilestone

​removeMilestone

​patchMilestoneLifecycle

​updateMilestone

Available Methods

`acceptManagerInvite`

`listPendingManagerInvites`

`getByID`

`listAttendees`

`addAttendee`

`bulkAddAttendees`

`removeAttendee`

`updateAttendeeStatus`

`checkInAttendee`

`listDocuments`

`removeDocument`

`addDocument`

`listLinks`

`addLink`

`removeLink`

`listMilestones`

`addMilestone`

`removeMilestone`

`patchMilestoneLifecycle`

`updateMilestone`