Access & visibility
Allow meetings.CreateMeeting on your API key. Resource read permissions: core:Meeting. Resource write permissions: core:Meeting.
Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.
Request fields
Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
dataMeetingRequiredThe record's fields.
Meeting
Meeting basics5 fields
titlestringOptionalMeeting title. May be absent when no title has been supplied.
start_timenumberRequiredMeeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field.
end_timenumberOptionalMeeting end time in Unix milliseconds. May be absent before the meeting ends.
languagestringOptionalLanguage recorded for the meeting, such as en or no. It may differ from summary_language.
meeting_typestringOptionalDescriptive meeting category in the meeting's language. Free text, not a fixed enum.
Participants and visibility1 fields
participantsarray of string or MeetingParticipantOptionalAttendee names or objects containing a name, email and optional Person record reference.
Item fields
MeetingParticipant
namestringOptionalDisplay name.
emailstringOptionalEmail address.
refstringOptionalPerson record ID for this attendee, when matched to a customer contact. It is not a workspace account ID.
Related records3 fields
contact_refsarray of stringOptionalLinked Person record IDs. Use has to filter for a particular contact.
company_refsarray of stringOptionalLinked Company record IDs. Use has to filter for a particular company.
Agenda1 fields
agendaarray of objectOptionalTwo-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
subtopicsarray of objectOptionalSecond-level discussion topics; no deeper nesting is supported.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
privatebooleanOptionalDefaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance.
Choose ownership deliberately
Omitting private, or setting it to false, creates a workspace-shared record. Set private: true to create a record owned by the approved acting member. Private records require member delegation; a workspace-only credential cannot own a personal record. The credential’s exact resource grants authorize the write; private ownership and project membership remain enforced.
A create is a new record, not an upsert. Reuse the same idempotency key only for retries of that logical creation. For recurring synchronization, use the resource’s upsert operation when available: it matches a permanent external reference. Otherwise keep the returned record ID and use the corresponding update operation for subsequent changes.
Response
Returns 200 OK with a JSON body.
Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.
An ended meeting is not necessarily summarized yet. Summary fields can be absent while work is pending or when no summary is available; this response does not expose the reason.
Transcript text and recording URLs are not part of this model. Personal notes are a separate resource and retain the acting member's access rules.
itemMeetingRecordRequiredThe requested record, including its metadata and data fields.
MeetingRecord
idstringRequiredStable core:Meeting record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.
created_atnumberRequiredTime the record was created, in Unix milliseconds.
updated_atnumberRequiredTime the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.
created_bystring or nullRequiredAccount that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.
privatebooleanRequiredTrue for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.
dataMeetingRequiredThe record's fields.
Meeting
Meeting basics6 fields
titlestringOptionalMeeting title. May be absent when no title has been supplied.
start_timenumberRequiredMeeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field.
end_timenumberOptionalMeeting end time in Unix milliseconds. May be absent before the meeting ends.
statusstringRequiredMeeting lifecycle state, including live, paused and ended. This is an open string, not a closed enum; tolerate additional states.
languagestringOptionalLanguage recorded for the meeting, such as en or no. It may differ from summary_language.
meeting_typestringOptionalDescriptive meeting category in the meeting's language. Free text, not a fixed enum.
Participants and visibility3 fields
started_bystringOptionalHost account ID. This is the member identity that owns the meeting; created_by is separate record provenance.
participantsarray of string or MeetingParticipantOptionalAttendee names or objects containing a name, email and optional Person record reference.
Item fields
MeetingParticipant
namestringOptionalDisplay name.
emailstringOptionalEmail address.
refstringOptionalPerson record ID for this attendee, when matched to a customer contact. It is not a workspace account ID.
sharing_externalbooleanOptionalWhether external attendees were identified when the meeting was prepared. This is not permission to share the meeting externally; absence means this fact was not recorded.
Summary5 fields
giststringOptionalOne- or two-line takeaway from the meeting.
summary_bulletsarray of stringOptionalKey points extracted from the meeting.
summarystringOptionalFull meeting summary formatted as Markdown.
summary_languagestringOptionalLanguage of the generated summary, such as en or no.
custom_summaryobjectOptionalInstructions and optional example used to generate a custom summary. This is configuration, not the generated summary.
Nested fields
examplestringOptionalExample output illustrating the desired summary style.
instructionsstringOptionalInstructions to follow when generating the summary.
Related records5 fields
calendar_event_idstringOptionalID of a core:CalendarEvent record. Find it with meetings.ListCalendarEvents and use the top-level id. This is not an account ID or a display name.
conference_urlstringOptionalConference link from the calendar invitation, when one is available.
contact_refsarray of stringOptionalLinked Person record IDs. Use has to filter for a particular contact.
company_refsarray of stringOptionalLinked Company record IDs. Use has to filter for a particular company.
Agenda1 fields
agendaarray of objectOptionalTwo-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
subtopicsarray of objectOptionalSecond-level discussion topics; no deeper nesting is supported.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
Phone calls5 fields
call_directionstringOptionalPhone call direction, currently inbound or outbound. Absent for meetings without phone-call metadata.
call_outcomestringOptionalHow a phone call ended, including completed, no_answer, busy, declined, canceled or failed. This is an open string.
call_duration_msnumberOptionalRecorded phone-call duration in milliseconds.
counterpart_e164stringOptionalOther party's phone number in international E.164 format, such as +4721001234.
call_forwardedbooleanOptionalWhether the incoming call was forwarded from another phone number.
Errors & retries
Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.
For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.
| HTTP status | Code | What to do |
|---|---|---|
| 400 | invalid_json |
Send a JSON object with Content-Type: application/json. |
| 400 | invalid_input |
Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | invalid_key |
The workspace API key is missing, invalid or revoked. |
| 403 | forbidden |
Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | not_found |
The requested operation or resource is not available to this credential. |
| 429 | rate_limited |
Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |
Next steps
JSON schemas
Use the complete schemas for validation or client generation.
Full request JSON schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Meeting title. May be absent when no title has been supplied."
},
"start_time": {
"type": "number",
"description": "Meeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field."
},
"end_time": {
"type": "number",
"description": "Meeting end time in Unix milliseconds. May be absent before the meeting ends."
},
"language": {
"type": "string",
"description": "Language recorded for the meeting, such as en or no. It may differ from summary_language."
},
"participants": {
"type": "array",
"items": {
"title": "MeetingParticipant",
"anyOf": [
{
"type": "string",
"title": "MeetingParticipant"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name."
},
"email": {
"type": "string",
"description": "Email address."
},
"ref": {
"type": "string",
"description": "Person record ID for this attendee, when matched to a customer contact. It is not a workspace account ID."
}
},
"required": [],
"additionalProperties": false,
"title": "MeetingParticipant"
}
]
},
"description": "Attendee names or objects containing a name, email and optional Person record reference."
},
"contact_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Person"
},
"description": "Linked Person record IDs. Use has to filter for a particular contact."
},
"company_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Company"
},
"description": "Linked Company record IDs. Use has to filter for a particular company."
},
"related_meetings": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Meeting"
},
"description": "IDs of related Meeting records. Each related record has its own access rules."
},
"agenda": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
},
"subtopics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
}
},
"additionalProperties": false
},
"description": "Second-level discussion topics; no deeper nesting is supported."
}
},
"additionalProperties": false
},
"description": "Two-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered."
},
"meeting_type": {
"type": "string",
"description": "Descriptive meeting category in the meeting's language. Free text, not a fixed enum."
}
},
"required": [
"start_time"
],
"additionalProperties": false,
"description": "The record's fields.",
"title": "Meeting"
},
"private": {
"type": "boolean",
"description": "Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance."
}
},
"required": [
"data"
],
"additionalProperties": false,
"examples": [
{
"data": {
"title": "Northstar · project kickoff",
"start_time": 1791277200000,
"end_time": 1791279900000,
"participants": [
{
"name": "Jamie Lee",
"email": "jamie@example.com"
},
{
"name": "Alex Morgan",
"email": "alex@example.org",
"ref": "e_person_alex"
}
],
"company_refs": [
"e_company_northstar"
]
}
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable core:Meeting record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
},
"created_at": {
"type": "number",
"description": "Time the record was created, in Unix milliseconds."
},
"updated_at": {
"type": "number",
"description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
},
"created_by": {
"type": [
"string",
"null"
],
"description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
},
"private": {
"type": "boolean",
"description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
},
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Meeting title. May be absent when no title has been supplied."
},
"started_by": {
"type": "string",
"description": "Host account ID. This is the member identity that owns the meeting; created_by is separate record provenance."
},
"start_time": {
"type": "number",
"description": "Meeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field."
},
"end_time": {
"type": "number",
"description": "Meeting end time in Unix milliseconds. May be absent before the meeting ends."
},
"status": {
"type": "string",
"description": "Meeting lifecycle state, including live, paused and ended. This is an open string, not a closed enum; tolerate additional states."
},
"language": {
"type": "string",
"description": "Language recorded for the meeting, such as en or no. It may differ from summary_language."
},
"participants": {
"type": "array",
"items": {
"title": "MeetingParticipant",
"anyOf": [
{
"type": "string",
"title": "MeetingParticipant"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name."
},
"email": {
"type": "string",
"description": "Email address."
},
"ref": {
"type": "string",
"description": "Person record ID for this attendee, when matched to a customer contact. It is not a workspace account ID."
}
},
"required": [],
"additionalProperties": false,
"title": "MeetingParticipant"
}
]
},
"description": "Attendee names or objects containing a name, email and optional Person record reference."
},
"calendar_event_id": {
"type": "string",
"description": "ID of a `core:CalendarEvent` record. Find it with [meetings.ListCalendarEvents](/developers/reference/meetings/ListCalendarEvents) and use the top-level `id`. This is not an account ID or a display name."
},
"sharing_external": {
"type": "boolean",
"description": "Whether external attendees were identified when the meeting was prepared. This is not permission to share the meeting externally; absence means this fact was not recorded."
},
"call_direction": {
"type": "string",
"description": "Phone call direction, currently inbound or outbound. Absent for meetings without phone-call metadata."
},
"call_outcome": {
"type": "string",
"description": "How a phone call ended, including completed, no_answer, busy, declined, canceled or failed. This is an open string."
},
"call_duration_ms": {
"type": "number",
"description": "Recorded phone-call duration in milliseconds."
},
"counterpart_e164": {
"type": "string",
"description": "Other party's phone number in international E.164 format, such as +4721001234."
},
"call_forwarded": {
"type": "boolean",
"description": "Whether the incoming call was forwarded from another phone number."
},
"conference_url": {
"type": "string",
"description": "Conference link from the calendar invitation, when one is available."
},
"contact_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Person"
},
"description": "Linked Person record IDs. Use has to filter for a particular contact."
},
"company_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Company"
},
"description": "Linked Company record IDs. Use has to filter for a particular company."
},
"related_meetings": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Meeting"
},
"description": "IDs of related Meeting records. Each related record has its own access rules."
},
"agenda": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
},
"subtopics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
}
},
"additionalProperties": false
},
"description": "Second-level discussion topics; no deeper nesting is supported."
}
},
"additionalProperties": false
},
"description": "Two-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered."
},
"meeting_type": {
"type": "string",
"description": "Descriptive meeting category in the meeting's language. Free text, not a fixed enum."
},
"gist": {
"type": "string",
"description": "One- or two-line takeaway from the meeting."
},
"summary_bullets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Key points extracted from the meeting."
},
"summary": {
"type": "string",
"description": "Full meeting summary formatted as Markdown."
},
"summary_language": {
"type": "string",
"description": "Language of the generated summary, such as en or no."
},
"custom_summary": {
"type": "object",
"properties": {
"example": {
"type": "string",
"description": "Example output illustrating the desired summary style."
},
"instructions": {
"type": "string",
"description": "Instructions to follow when generating the summary."
}
},
"additionalProperties": false,
"description": "Instructions and optional example used to generate a custom summary. This is configuration, not the generated summary."
}
},
"required": [
"start_time",
"status"
],
"additionalProperties": false,
"description": "The record's fields.",
"title": "Meeting"
}
},
"required": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data"
],
"additionalProperties": false,
"description": "The requested record, including its metadata and data fields.",
"title": "MeetingRecord"
}
},
"required": [
"item"
],
"additionalProperties": false,
"examples": [
{
"item": {
"id": "e_meeting_example",
"created_at": 1791276900000,
"updated_at": 1791280800000,
"created_by": "a_jamie",
"private": false,
"data": {
"title": "Northstar · project kickoff",
"start_time": 1791277200000,
"end_time": 1791279900000,
"status": "ended",
"started_by": "a_jamie",
"participants": [
{
"name": "Jamie Lee",
"email": "jamie@example.com"
},
{
"name": "Alex Morgan",
"email": "alex@example.org",
"ref": "e_person_alex"
}
],
"company_refs": [
"e_company_northstar"
],
"gist": "The team agreed to begin the pilot on 19 October.",
"summary_bullets": [
"Alex will send the source data by Friday.",
"Jamie will prepare the pilot workspace."
],
"summary": "## Decisions\nStart the pilot on 19 October.\n\n## Next steps\n- Alex: send source data by Friday.\n- Jamie: prepare the workspace.",
"summary_language": "en"
}
}
}
]
}