Properties
| Name | Type | Description |
|---|---|---|
| id | string | A unique identifier for the summary. |
| meetingId | string | Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the summary belongs. |
| status | string | * `available` - Summary is available. * `deleted` - Summary has been deleted. Normal users can only see available summaries. Compliance officers can see both available and deleted summaries. |
| notes | object | Meeting summaries in HTML format |
| actionItems | array | A list of action items |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SummaryObject",
"title": "SummaryObject",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c7428c95-df5f-442c-800a-81a2c1e95500",
"description": "A unique identifier for the summary."
},
"meetingId": {
"type": "string",
"example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044",
"description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the summary belongs."
},
"status": {
"type": "string",
"example": "available",
"enum": [
"available",
"deleted"
],
"description": " * `available` - Summary is available.\n * `deleted` - Summary has been deleted.\n\n Normal users can only see available summaries. Compliance officers can see both available and deleted summaries."
},
"notes": {
"type": "object",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"example": "<p>Summary of the meeting in HTML format</p>",
"description": "Summary of the meeting in HTML format"
}
},
"description": "Meeting summaries in HTML format"
},
"actionItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"example": "Action item in plaintext",
"description": "Action item in plaintext"
}
},
"description": "One ation item in plaintext"
},
"description": "A list of action items"
}
},
"example": {
"id": "75ddf169-eef0-45b4-9faa-0112a16ec9d0",
"meetingId": "d32a7aee5d864adcb8aab61b03e2a64d_I_688397330631637738",
"status": "available",
"notes": {
"content": "<p>Summary of the meeting in HTML format</p>"
},
"actionItems": [
{
"content": "Action item No.1 in plaintext"
},
{
"content": "Action item No.2 in plaintext"
},
{
"content": "Action item No.3 in plaintext"
}
]
}
}