Access & visibility
Allow meetings.ListMeetings on your API key. Resource read 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.
filtersarray of objectOptionalConditions the row must ALL satisfy.
Item fields
fieldstringRequireddata.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.
Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.title", "data.started_by", "data.start_time", "data.end_time", "data.status", "data.language", "data.participants", "data.calendar_event_id", "data.sharing_external", "data.call_direction", "data.call_outcome", "data.call_duration_ms", "data.counterpart_e164", "data.call_forwarded", "data.conference_url", "data.contact_refs", "data.company_refs", "data.related_meetings", "data.agenda", "data.meeting_type", "data.gist", "data.summary_bullets", "data.summary", "data.summary_language", "data.custom_summary".
opstringRequiredComparison operator. Use in with an array, or omit value for is_empty and is_not_empty.
Allowed: "eq", "neq", "contains", "starts_with", "gt", "gte", "lt", "lte", "in", "has", "is_empty", "is_not_empty".
valueJSON valueOptionalThe comparison value; an array for in; omitted for is_empty / is_not_empty.
sortobjectOptionalSort order for the results. Defaults to updated_at descending, with id as a tie-breaker.
Nested fields
fieldstringRequireddata.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.
Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.title", "data.started_by", "data.start_time", "data.end_time", "data.status", "data.language", "data.participants", "data.calendar_event_id", "data.sharing_external", "data.call_direction", "data.call_outcome", "data.call_duration_ms", "data.counterpart_e164", "data.call_forwarded", "data.conference_url", "data.contact_refs", "data.company_refs", "data.related_meetings", "data.agenda", "data.meeting_type", "data.gist", "data.summary_bullets", "data.summary", "data.summary_language", "data.custom_summary".
directionstringOptionalSort direction: asc for ascending or desc for descending.
Allowed: "asc", "desc".
limitintegerOptionalMaximum number of results to return in this page. Continue with next_cursor when returned.
Default: 100. Minimum: 1.
cursorstringOptionalThe next_cursor of the previous page.
Filtering and sorting
All conditions are combined with AND. Address business fields as data.<field>, and record metadata as id, created_at, updated_at, created_by or private. A field path names one field; it does not traverse nested objects.
| Operator | Meaning | Value |
|---|---|---|
eq |
Equal to a scalar | String, number, boolean or null |
neq |
Not equal; missing values also match | String, number, boolean or null |
contains |
Case-insensitive text contains | String; % and _ are literal characters |
starts_with |
Case-insensitive text prefix | String |
gt, gte |
Greater than / at least | Number or string appropriate to the field |
lt, lte |
Less than / at most | Number or string appropriate to the field |
in |
Equal to any supplied scalar | Nonempty array of strings, numbers, booleans or null |
has |
Array contains a string | One string; does not match properties inside array objects |
is_empty |
Missing, null, empty string or empty array | Omit value |
is_not_empty |
Has a nonempty value | Omit value |
Match the stored field's type. Numeric business timestamps take Unix milliseconds; date-only business fields take YYYY-MM-DD. The record metadata fields created_at and updated_at also accept ISO timestamps for ordered comparisons.
Sorting defaults to updated_at descending. If you supply sort.field without sort.direction, direction is desc. The record ID breaks ties; missing values sort last.
Response
Returns 200 OK with a JSON body.
An empty items array means this page contains no matching visible results. Follow next_cursor when present.
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.
itemsarray of MeetingRecordRequiredRecords visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned.
Item fields
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.
next_cursorstringOptionalPass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results.
Pagination
Pass next_cursor from the response as cursor on the next request. Keep the same filters, sort and acting identity. Stop when next_cursor is absent; do not infer completion from the number of items. The default page size is 100; limit must be a positive integer.
Pagination is a live view, not a snapshot. Changes between pages can move records across page boundaries. Upsert by record ID rather than appending blindly. For recurring synchronization, use an overlapping update window and deduplicate records. Periodically reconcile IDs to detect deletions. Resource webhooks can supplement synchronization for eligible workspace-shared records only: they do not export private or project-scoped records. Personal data still needs polling and reconciliation.
const query = {
"sort": {
"field": "data.start_time",
"direction": "desc"
},
"limit": 50
};
let cursor;
do {
const response = await fetch("https://api.brigg.app/v1/operations/meetings.ListMeetings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
});
const page = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
for (const item of page.items) {
console.log(item); // Process or upsert each result.
}
cursor = page.next_cursor;
} while (cursor);Errors & retries
This operation reads data. It needs no idempotency key and can be retried after a transient failure.
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. |
| 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. |
| 400 | cursor_invalid |
Restart pagination with no cursor. |
| 400 | cursor_mismatch |
Use the cursor with the original filters, sort order and credential. |
Next steps
JSON schemas
Use the complete schemas for validation or client generation.
Full request JSON schema
{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
"enum": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data.title",
"data.started_by",
"data.start_time",
"data.end_time",
"data.status",
"data.language",
"data.participants",
"data.calendar_event_id",
"data.sharing_external",
"data.call_direction",
"data.call_outcome",
"data.call_duration_ms",
"data.counterpart_e164",
"data.call_forwarded",
"data.conference_url",
"data.contact_refs",
"data.company_refs",
"data.related_meetings",
"data.agenda",
"data.meeting_type",
"data.gist",
"data.summary_bullets",
"data.summary",
"data.summary_language",
"data.custom_summary"
]
},
"op": {
"type": "string",
"enum": [
"eq",
"neq",
"contains",
"starts_with",
"gt",
"gte",
"lt",
"lte",
"in",
"has",
"is_empty",
"is_not_empty"
],
"description": "Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty."
},
"value": {
"description": "The comparison value; an array for `in`; omitted for is_empty / is_not_empty."
}
},
"required": [
"field",
"op"
],
"additionalProperties": false
},
"description": "Conditions the row must ALL satisfy."
},
"sort": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
"enum": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data.title",
"data.started_by",
"data.start_time",
"data.end_time",
"data.status",
"data.language",
"data.participants",
"data.calendar_event_id",
"data.sharing_external",
"data.call_direction",
"data.call_outcome",
"data.call_duration_ms",
"data.counterpart_e164",
"data.call_forwarded",
"data.conference_url",
"data.contact_refs",
"data.company_refs",
"data.related_meetings",
"data.agenda",
"data.meeting_type",
"data.gist",
"data.summary_bullets",
"data.summary",
"data.summary_language",
"data.custom_summary"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort direction: asc for ascending or desc for descending."
}
},
"required": [
"field"
],
"additionalProperties": false,
"description": "Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker."
},
"limit": {
"type": "integer",
"minimum": 1,
"default": 100,
"description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
},
"cursor": {
"type": "string",
"description": "The `next_cursor` of the previous page."
}
},
"additionalProperties": false,
"examples": [
{
"sort": {
"field": "data.start_time",
"direction": "desc"
},
"limit": 50
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"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,
"title": "MeetingRecord"
},
"description": "Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned."
},
"next_cursor": {
"type": "string",
"description": "Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results."
}
},
"required": [
"items"
],
"additionalProperties": false,
"examples": [
{
"items": [
{
"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"
}
}
]
}
]
}