Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthGathering

Gathering routes: create, get, list

The Gathering Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Gathering, one group of Gathering routes.

Gathering.create

Creates a Gathering. Verb page.

Text
POST /{namespace}/gatherings

Body, as JSON: the inputs. Emits Gathering.created.

Inputs

InputTypeRequiredDescription
titlestringrequiredWhat the Gathering is called on its Page and invitations.
atdatetimerequiredWhen it starts.
capacityintegerThe most Registrations it admits before new ones join the waitlist.
recordingurlWhere the replay lives once it ends.

Returns

OutputTypeRequiredDescription
gatheringGatheringrequiredThe Gathering.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/gatherings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Leaseline Pro","at":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "gathering": {
    "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
    "$type": "Gathering",
    "title": "Leaseline Pro",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Gathering.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Gathering.get

Returns one Gathering by id. Verb page.

Text
GET /{namespace}/gatherings/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Gathering.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
gatheringGatheringrequiredThe Gathering.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Gathering",
  "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
  "gathering": {
    "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
    "$type": "Gathering",
    "title": "Leaseline Pro",
    "at": "2026-10-22T12:00:00Z"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
    "up": "https://api.sb/leaseline.app/gatherings"
  },
  "actions": {
    "register": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR/register"
  }
}

Gathering.list

Returns Gatherings, newest first, one page at a time. Verb page.

Text
GET /{namespace}/gatherings

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
gatheringslist of GatheringrequiredOne page of Gatherings.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/gatherings?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Gathering",
  "gatherings": [
    {
      "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
      "$type": "Gathering",
      "title": "Leaseline Pro",
      "at": "2026-10-22T12:00:00Z"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "gathering_ACB9Q1atRR"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/gatherings?limit=20",
    "next": "https://api.sb/leaseline.app/gatherings?after=gathering_ACB9Q1atRR"
  }
}

Gathering

Previous

update, delete

Next