Gathering · StartupBuilder

Properties

Property	Type	Required	Description
`title`	`string`	required	What the Gathering is called on its Page and invitations.
`at`	`datetime`	required	When it starts.
`capacity`	`integer`		The most Registrations it admits before new ones join the waitlist.
`recording`	`url`		Where the replay lives once it ends.

Object

JSON

{
  "$id": "https://api.sb/shiftnote.app/gatherings/gathering_1",
  "$type": "Gathering",
  "title": "Clinic schedule",
  "at": "2026-10-22T12:00:00Z",
  "capacity": 1,
  "recording": "https://shiftnote.app"
}

Relationships

A Gathering admits many Registrations: a Gathering admits Registrations up to its capacity, then waitlists the rest. admits, inverse gathering.

Verbs

createCreates a Gathering.
POST /{namespace}/gatheringsdoGathering.created
getReturns one Gathering by id.
GET /{namespace}/gatherings/{id}readNo Event
listReturns Gatherings, newest first, one page at a time.
GET /{namespace}/gatheringsreadNo Event
updateChanges the given properties of a Gathering.
PATCH /{namespace}/gatherings/{id}doGathering.updated
deleteDeletes a Gathering; its history is kept.
DELETE /{namespace}/gatherings/{id}doGathering.deleted
registerRegister gives a Contact a place at a Gathering, or a waitlist place when the Gathering is full.
POST /{namespace}/gatherings/{gathering}/registerdoGathering.registered

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Gathering.create`	Yes	Yes	Yes	No
`Gathering.get`	Yes	Yes	Yes	Yes
`Gathering.list`	Yes	Yes	Yes	Yes
`Gathering.update`	Yes	Yes	Yes	No
`Gathering.delete`	Yes	Yes	Yes	No
`Gathering.register`	Yes	Yes	Yes	No

Call it

Text

Register the latest gathering with a contact.

Example

A bookkeeping app hosts a 45-minute workshop on closing the month, with capacity for 300. The 301st Registration joins the waitlist, and the replay link goes to every registrant the next morning.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link