Meeting methods: create, get, list

Reference for Meeting, one group of Meeting methods.

Meeting.create

Creates a Meeting. Verb page.

TypeScript

interface MeetingVerbs {
  create(input: MeetingCreateInput, options?: SB.CallOptions): SB.Call<Meeting>
}

Emits Meeting.created.

Inputs

Input	Type	Required	Description
`at`	`datetime`	required	When it starts.
`agenda`	`text`		What it covers.
`transcript`	`text`		What was said.
`duration`	`integer`		How long it runs, in minutes.
`medium`	`string`		How people meet: `video`, `phone` or `inPerson`.
`joinUrl`	`url`		The video link attendees join from.
`location`	`string`		Where it happens, when people meet in person.
`meetingType`	Meeting Type		The Meeting Type it was booked from, when booked from a link.
`deal`	Deal		A Meeting moves one Deal forward.

Returns

Output	Type	Required	Description
`meeting`	Meeting	required	The Meeting.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const meeting = await $.Meeting.create({ at: '2026-10-22T12:00:00Z' })

Returns one Meeting by id. Verb page.

TypeScript

interface MeetingVerbs {
  get(input: MeetingGetInput, options?: SB.CallOptions): SB.Call<Meeting>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Meeting.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`meeting`	Meeting	required	The Meeting.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const meeting = await $.Meeting.get({ id: 'meeting_TyEQGjh9uX' })

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

TypeScript

interface MeetingVerbs {
  list(input?: MeetingListInput, options?: SB.CallOptions): SB.ListCall<Meeting>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`meetings`	list of Meeting	required	One page of Meetings.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const meetings = await $.Meeting.list({ limit: 20 })