Skip to content

Meeting Type commands: create, get, list

The Meeting Type Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for Meeting Type, one group of Meeting Type commands.

MeetingType.create

Creates a Meeting Type. Verb page.

Text
npx startup-builder do MeetingType.create --json '<input>' [--try | --send | --do]

Emits MeetingType.created.

Inputs

InputTypeRequiredDescription
namestringrequiredWhat the booking page calls it, such as Intro call.
durationintegerrequiredMinutes each Meeting runs.
mediumstringrequiredHow people meet: video, phone or inPerson.
availabilityAvailabilityrequiredThe hours it books into.
urlurlThe booking link, served on the Startup’s Domain once published.
questionsstring[]What the booker answers before the time is held.
offerOfferThe Offer a paid booking accepts first, with its deposit and no-show rule.

Returns

OutputTypeRequiredDescription
meetingTypeMeeting TyperequiredThe Meeting Type.

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
npx startup-builder do MeetingType.create --json '{"name":"Problem interview","duration":20,"medium":"video","availability":"availability_8Zj0a7vvRl"}'

MeetingType.get

Returns one Meeting Type by id. Verb page.

Text
npx startup-builder do MeetingType.get --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

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

Returns

OutputTypeRequiredDescription
meetingTypeMeeting TyperequiredThe Meeting Type.

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
npx startup-builder do MeetingType.get --json '{"id":"mtgtype_qw2d5yGLVN"}'

MeetingType.list

Returns Meeting Types, newest first, one page at a time. Verb page.

Text
npx startup-builder do MeetingType.list --json '<input>' [--try]

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
meetingTypeslist of Meeting TyperequiredOne page of Meeting Types.

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
npx startup-builder do MeetingType.list --json '{"limit":20}'