{ "openapi": "3.1.0", "info": { "title": "Notion Calendar API", "version": "2.0.0" }, "security": [ { "bearerToken": [] } ], "servers": [ { "url": "https://calendar-api.notion.so/v2" } ], "paths": { "/createConferencing": { "post": { "operationId": "createConferencing", "summary": "Create conferencing", "requestBody": { "description": "Create conferencing request", "content": { "application/json": { "schema": { "type": "object", "properties": { "providerName": { "type": "string", "enum": [ "zoom" ] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "topic": { "type": "string" }, "timeZone": { "type": "string" }, "isRecurring": { "type": "boolean" } }, "required": [ "providerName", "startTime", "topic" ] } } } }, "responses": { "200": { "description": "Created conferencing", "content": { "application/json": { "schema": { "type": "object", "properties": { "meeting": { "type": "object", "properties": { "id": { "type": "string" }, "password": { "type": "string" }, "joinUrl": { "type": "string" } }, "required": [ "id", "joinUrl" ], "additionalProperties": false } }, "required": [ "meeting" ], "additionalProperties": false } } } } } } }, "/createEvent": { "post": { "operationId": "createEvent", "summary": "Create event", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mutation": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "eventData": { "$ref": "#/components/schemas/CalendarEvent" }, "sendUpdates": { "type": "string", "enum": [ "all", "none", "externalOnly" ] }, "order": { "type": "string", "enum": [ "FIRST" ] } }, "required": [ "provider", "accountId", "calendarId", "eventData" ] } }, "required": [ "mutation" ] } } } }, "responses": { "200": { "description": "Created event", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "event": { "$ref": "#/components/schemas/CalendarEvent" } }, "required": [ "accountId", "calendarId", "event" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } }, "/createNotionSession": { "post": { "operationId": "createNotionSession", "summary": "Create Notion session", "security": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preAuthToken": { "type": "string" }, "context": { "type": "object", "properties": { "from": { "type": [ "string", "null" ] }, "notionDeviceId": { "type": [ "string", "null" ] }, "referralCode": { "type": [ "string", "null" ] }, "workspaceId": { "type": [ "string", "null" ] }, "collectionViewId": { "type": [ "string", "null" ] }, "redirectUri": { "type": [ "string", "null" ] } } } }, "required": [ "preAuthToken", "context" ] } } } }, "responses": { "200": { "description": "Session credentials and user info", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "isNewUser": { "type": "boolean" } }, "required": [ "user", "isNewUser" ], "additionalProperties": false } } } } } } }, "/deleteConferencing": { "post": { "operationId": "deleteConferencing", "summary": "Delete conferencing", "requestBody": { "description": "Delete conferencing request", "content": { "application/json": { "schema": { "type": "object", "properties": { "meetingId": { "type": "string" }, "scheduleForReminder": { "type": "boolean" } }, "required": [ "meetingId", "scheduleForReminder" ] } } } }, "responses": { "200": { "description": "Deleted conferencing", "content": { "application/json": { "schema": { "type": "object", "properties": { "meetingId": { "type": "string" } }, "required": [ "meetingId" ], "additionalProperties": false } } } } } } }, "/deleteEvents": { "post": { "operationId": "deleteEvents", "summary": "Delete events", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mutations": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "eventId": { "type": "string" }, "sendUpdates": { "type": "string", "enum": [ "all", "none", "externalOnly" ] } }, "required": [ "provider", "accountId", "calendarId", "eventId" ] } } }, "required": [ "mutations" ] } } } }, "responses": { "200": { "description": "Delete event results", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } } }, "/getCalendars": { "post": { "operationId": "getCalendars", "summary": "Get calendars", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "queries": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "query": { "type": "string" }, "haveUsed": { "type": "boolean" }, "suggested": { "type": "boolean" } }, "required": [ "provider", "accountId" ] } } }, "required": [ "queries" ] } } } }, "responses": { "200": { "description": "Calendars", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string" }, "calendars": { "type": "array", "items": { "$ref": "#/components/schemas/Calendar" } } }, "required": [ "accountId", "calendars" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } } }, "/getPeople": { "post": { "operationId": "getPeople", "summary": "Get people", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "string" } }, "cursor": { "type": "string" }, "limit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 5000 } } } } } }, "responses": { "200": { "description": "People", "content": { "application/json": { "schema": { "type": "object", "properties": { "people": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "providerName": { "$ref": "#/components/schemas/DataProvider" }, "source": { "type": "string", "enum": [ "contact", "otherContact", "directory" ] }, "sourceId": { "type": "string" }, "email": { "type": "string" }, "alternateEmails": { "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string" }, "avatarUrl": { "type": "string" }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "primary": { "type": "boolean" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "additionalProperties": false }, "type": { "type": "string" }, "formattedType": { "type": "string" }, "canonicalForm": { "type": "string" }, "value": { "type": "string" } }, "required": [ "metadata", "type", "formattedType", "value" ], "additionalProperties": false } } }, "required": [ "id", "accountId", "providerName", "source", "sourceId", "email" ], "additionalProperties": false } }, "nextCursor": { "type": "string" }, "sourceErrors": { "type": "array", "items": { "type": "object", "properties": { "sourceKey": { "type": "string" }, "accountId": { "type": "string" }, "providerName": { "$ref": "#/components/schemas/DataProvider" }, "message": { "type": "string" } }, "required": [ "sourceKey", "accountId", "providerName", "message" ], "additionalProperties": false } } }, "required": [ "people" ], "additionalProperties": false } } } } } } }, "/getEvents": { "post": { "operationId": "getEvents", "summary": "Get calendar events", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "queries": { "type": "array", "items": { "type": "object", "properties": { "provider": { "default": "google", "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "timeMin": { "type": "number" }, "timeMax": { "type": "number" }, "singleEvents": { "type": "boolean" }, "showDeleted": { "type": "boolean" }, "query": { "type": "string" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "participants": { "type": "boolean" }, "orderBy": { "type": "string" }, "includeUnscheduled": { "type": "boolean" }, "unfurlGroups": { "type": "boolean" }, "pageToken": { "type": "string" }, "syncToken": { "type": "string" }, "metadata": { "type": "object", "properties": { "caller": { "type": "string", "enum": [ "addAccountFlow", "initialization", "participantCalendar", "postCalendarMove", "resourceCalendar", "search", "teammateCalendar", "websocket", "zeroCalendarPanic", "getHold", "getHoldEvent", "createEventFromHold", "createHoldEvent", "updateHoldEvent", "fetchNotionDatabaseViews" ] }, "websocketId": { "type": "string" } } } }, "required": [ "accountId", "calendarId" ] } } }, "required": [ "queries" ] } } } }, "responses": { "200": { "description": "Events", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "syncToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "accountId", "calendarId", "events" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } } }, "/searchEvents": { "post": { "operationId": "searchEvents", "summary": "Search calendar events across an account", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "timeMin": { "type": "number" }, "timeMax": { "type": "number" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accountId", "calendarIds" ] } } }, "required": [ "query", "timeMin", "timeMax", "accounts" ] } } } }, "responses": { "200": { "description": "Search results", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DataProviderError" } } }, "required": [ "events", "errors" ], "additionalProperties": false } } } } } } }, "/getSnapshotEvents": { "post": { "operationId": "getSnapshotEvents", "summary": "Get a snapshot of calendar events in a time range", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "timeMin": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeMax": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "query": { "type": "string" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "pageToken": { "type": "string" }, "metadata": { "type": "object", "properties": { "caller": { "type": "string", "enum": [ "addAccountFlow", "initialization", "participantCalendar", "postCalendarMove", "resourceCalendar", "search", "teammateCalendar", "websocket", "zeroCalendarPanic", "getHold", "getHoldEvent", "createEventFromHold", "createHoldEvent", "updateHoldEvent", "fetchNotionDatabaseViews" ] }, "websocketId": { "type": "string" } } } }, "required": [ "accountId", "calendarId", "timeMin", "timeMax", "limit" ] } } } }, "responses": { "200": { "description": "Snapshot events", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "pageToken": { "type": "string" } }, "required": [ "accountId", "calendarId", "events" ], "additionalProperties": false } } } } } } }, "/getOrgEvents": { "post": { "operationId": "getOrgEvents", "summary": "Get organization person/room/resource's calendar events in a time range", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "email": { "type": "string" }, "timeMin": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeMax": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "pageToken": { "type": "string" }, "metadata": { "type": "object", "properties": { "caller": { "type": "string", "enum": [ "addAccountFlow", "initialization", "participantCalendar", "postCalendarMove", "resourceCalendar", "search", "teammateCalendar", "websocket", "zeroCalendarPanic", "getHold", "getHoldEvent", "createEventFromHold", "createHoldEvent", "updateHoldEvent", "fetchNotionDatabaseViews" ] }, "websocketId": { "type": "string" } } } }, "required": [ "accountId", "email", "timeMin", "timeMax", "limit" ] } } } }, "responses": { "200": { "description": "Org events", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "email": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "pageToken": { "type": "string" } }, "required": [ "accountId", "email", "events" ], "additionalProperties": false } } } } } } }, "/getSyncEvents": { "post": { "operationId": "getSyncEvents", "summary": "Get calendar events for initial sync with a sync token", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "timeMin": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeMax": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "pageToken": { "type": "string" }, "metadata": { "type": "object", "properties": { "caller": { "type": "string", "enum": [ "addAccountFlow", "initialization", "participantCalendar", "postCalendarMove", "resourceCalendar", "search", "teammateCalendar", "websocket", "zeroCalendarPanic", "getHold", "getHoldEvent", "createEventFromHold", "createHoldEvent", "updateHoldEvent", "fetchNotionDatabaseViews" ] }, "websocketId": { "type": "string" } } } }, "required": [ "accountId", "calendarId", "timeMin", "timeMax", "limit" ] } } } }, "responses": { "200": { "description": "Sync events with sync token", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "syncToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "accountId", "calendarId", "events" ], "additionalProperties": false } } } } } } }, "/getSyncDeltaEvents": { "post": { "operationId": "getSyncDeltaEvents", "summary": "Get incremental calendar event changes using a sync token", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "syncToken": { "type": "string" }, "userTimeZone": { "type": "string" }, "limit": { "type": "number" }, "pageToken": { "type": "string" }, "metadata": { "type": "object", "properties": { "caller": { "type": "string", "enum": [ "addAccountFlow", "initialization", "participantCalendar", "postCalendarMove", "resourceCalendar", "search", "teammateCalendar", "websocket", "zeroCalendarPanic", "getHold", "getHoldEvent", "createEventFromHold", "createHoldEvent", "updateHoldEvent", "fetchNotionDatabaseViews" ] }, "websocketId": { "type": "string" } } } }, "required": [ "accountId", "calendarId", "syncToken", "limit" ] } } } }, "responses": { "200": { "description": "Delta sync events or invalid sync token indicator", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "invalidSyncToken": { "type": "boolean", "const": false }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "syncToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "invalidSyncToken", "accountId", "calendarId", "events" ], "additionalProperties": false }, { "type": "object", "properties": { "invalidSyncToken": { "type": "boolean", "const": true }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "syncToken": { "type": "string" } }, "required": [ "invalidSyncToken", "accountId", "calendarId", "syncToken" ], "additionalProperties": false } ], "type": "object" } } } } } } }, "/getGroupMembers": { "post": { "operationId": "getGroupMembers", "summary": "Get group members", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "emails": { "type": "array", "items": { "type": "string" } } }, "required": [ "accountId", "emails" ] } } } }, "responses": { "200": { "description": "Group members", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "isGroup": { "type": "boolean", "const": false } }, "required": [ "isGroup" ], "additionalProperties": false }, { "type": "object", "properties": { "isGroup": { "type": "boolean", "const": true }, "members": { "type": "array", "items": { "type": "string" } }, "isTooBig": { "type": "boolean" } }, "required": [ "isGroup", "members", "isTooBig" ], "additionalProperties": false } ], "type": "object" } } } } } } } }, "/getGroupMemberAttendees": { "post": { "operationId": "getGroupMemberAttendees", "summary": "Get group member attendees", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "string" }, "groupMembers": { "type": "array", "items": { "type": "string" } }, "accountId": { "type": "string" } }, "required": [ "eventId", "groupMembers", "accountId" ] } } } }, "responses": { "200": { "description": "Group member attendee RSVP statuses", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "attendees": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string" }, "additionalGuests": { "type": "number" }, "comment": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "optional": { "type": [ "boolean", "null" ] }, "organizer": { "type": "boolean" }, "resource": { "type": "boolean" }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "self": { "type": "boolean" }, "groupMembers": { "type": "array", "items": { "type": "string" } } }, "required": [ "responseStatus" ], "additionalProperties": false } } }, "required": [ "attendees" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } }, "/getUser": { "post": { "operationId": "getUser", "summary": "Get user", "responses": { "200": { "description": "User object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/getUserSettings": { "post": { "operationId": "getUserSettings", "summary": "Get user settings", "responses": { "200": { "description": "User settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "ai": { "type": "object", "properties": { "notionAccountId": { "type": "string" } }, "additionalProperties": false }, "meetingPrep": { "type": "object", "properties": { "includeAllDayEvents": { "type": "boolean" }, "includeJustYouEvents": { "type": "boolean" }, "enabled": { "type": "boolean" }, "recurrence": { "type": "object", "properties": { "frequency": { "type": "string", "const": "day" }, "interval": { "type": "number", "const": 1 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 } }, "required": [ "frequency", "interval", "hour" ], "additionalProperties": false }, "calendars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } } } }, "additionalProperties": false }, "timeZones": { "type": "object", "properties": { "labels": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "recency": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "visibility": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "primaryId": { "type": "string" }, "isAutoDetectDisabled": { "type": "boolean" } }, "additionalProperties": false }, "timeFormat": { "type": "string", "enum": [ "12-hour", "24-hour", "system" ] }, "locations": { "type": "object", "properties": { "mapsApp": { "type": "string", "enum": [ "google", "apple" ] } }, "additionalProperties": false } }, "required": [ "timeZones", "timeFormat", "locations" ], "additionalProperties": false } } } } } } }, "/identifyDevice": { "post": { "operationId": "identifyDevice", "summary": "Identify device", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "android", "electron", "ios", "web" ] }, "type": { "type": "string", "enum": [ "desktop", "phone", "tablet" ] }, "vendorId": { "type": "string" }, "appId": { "type": "string" }, "pushToken": { "type": [ "string", "null" ] } }, "required": [ "platform", "type", "vendorId" ] } } } }, "responses": { "200": { "description": "Identify device response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": true } }, "required": [ "success" ], "additionalProperties": false } } } } } } }, "/refreshNotionSession": { "post": { "operationId": "refreshNotionSession", "summary": "Refresh Notion session", "security": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshToken": { "type": "string" } }, "required": [ "refreshToken" ] } } } }, "responses": { "200": { "description": "Refreshed session credentials", "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "accessTokenExpiresAt": { "type": "string" } }, "required": [ "accessToken", "refreshToken", "accessTokenExpiresAt" ], "additionalProperties": false } } } } } } }, "/resolveLocation": { "post": { "operationId": "resolveLocation", "summary": "Resolve location", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string" }, "result": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string", "const": "google" }, "name": { "type": "string" }, "secondaryText": { "type": "string" }, "kind": { "type": "string", "enum": [ "address", "pointOfInterest", "unknown" ] } }, "required": [ "id", "source", "name", "kind" ] } }, "required": [ "sessionId", "result" ] } } } }, "responses": { "200": { "description": "Resolved location", "content": { "application/json": { "schema": { "type": "object", "properties": { "location": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string", "const": "google" }, "name": { "type": "string" }, "formattedAddress": { "type": "string" }, "kind": { "type": "string", "enum": [ "address", "pointOfInterest", "unknown" ] }, "eventLocationText": { "type": "string" }, "place": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poi", "address" ] }, "googlePlaceId": { "type": "string" }, "name": { "type": "string" }, "formattedAddress": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "source", "name", "kind", "eventLocationText", "place" ], "additionalProperties": false } }, "required": [ "location" ], "additionalProperties": false } } } } } } }, "/searchLocations": { "post": { "operationId": "searchLocations", "summary": "Search locations", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string" }, "query": { "type": "string" }, "languageCode": { "type": "string" }, "regionCode": { "type": "string" }, "locationBias": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "radiusMeters": { "type": "number" } }, "required": [ "latitude", "longitude", "radiusMeters" ] } }, "required": [ "sessionId", "query" ] } } } }, "responses": { "200": { "description": "Location search results", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string", "const": "google" }, "name": { "type": "string" }, "secondaryText": { "type": "string" }, "kind": { "type": "string", "enum": [ "address", "pointOfInterest", "unknown" ] } }, "required": [ "id", "source", "name", "kind" ], "additionalProperties": false } } }, "required": [ "results" ], "additionalProperties": false } } } } } } }, "/updateCalendars": { "post": { "operationId": "updateCalendars", "summary": "Update calendars", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mutations": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "calendarData": { "type": "object", "properties": { "accountId": { "type": "string" }, "accessRole": { "type": "string", "enum": [ "freeBusyReader", "reader", "writer", "owner" ], "description": "Access level the user has over this calendar." }, "defaultReminders": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarReminder" } }, "etag": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "calendar#calendarList", "calendar#calendarListEntry", "calendar#participant", "calendar#teammate", "calendar#timeCollectionView" ] }, "summary": { "type": "string" }, "provider": { "$ref": "#/components/schemas/DataProvider" }, "notificationSettings": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "const": "email" }, "type": { "type": "string", "enum": [ "eventCreation", "eventChange", "eventCancellation", "eventResponse", "agenda" ] } }, "required": [ "method", "type" ] } } }, "required": [ "notifications" ] }, "conferenceProperties": { "type": "object", "properties": { "allowedConferenceSolutionTypes": { "type": "array", "items": { "type": "string", "enum": [ "eventHangout", "eventNamedHangout", "hangoutsMeet", "teamsForBusiness", "addOn" ] } } } }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "location": { "type": "string" }, "primary": { "type": "boolean" }, "selected": { "type": "boolean" }, "summaryOverride": { "type": [ "string", "null" ] }, "timeZone": { "type": "string" }, "selfAttendee": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" } } }, "owner": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" }, "self": { "type": "boolean" } } }, "backgroundColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "colorId": { "deprecated": true, "type": "string" }, "foregroundColor": { "deprecated": true, "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "orderIndex": { "type": "string" }, "pinned": { "type": "boolean" }, "teammate": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ] }, "subtitle": { "type": "string" }, "emoji": { "type": "string" }, "iconUrl": { "type": "string" }, "notionViewType": { "type": "string" }, "notionViewIcon": { "type": "string" }, "notionUrl": { "type": "string" }, "notionPath": { "type": "array", "items": { "type": "string" } }, "notionParentId": { "type": "string" }, "notionStatusPropertyId": { "type": [ "string", "null" ] }, "notionCollection": { "type": "object", "properties": { "id": { "type": "string" }, "properties": {}, "propertyFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "property" ] } }, "propertyVisibilityFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "show", "hide", "hide_if_empty", "section" ] }, { "type": "string" } ] } }, "required": [ "property", "visibility" ] } }, "timePropertyId": { "type": "string" }, "statusFilter": { "type": "string", "enum": [ "all", "notDone" ] }, "dateFilter": { "type": "string", "enum": [ "all", "scheduled", "unscheduled" ] }, "availableViews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "collectionId": { "type": "string" }, "iconPath": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id", "type", "name" ] } }, "groupBy": { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ] } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ] }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ] } }, "required": [ "property", "type", "sort" ] }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, "groupByOverride": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ] } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ] }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ] } }, "required": [ "property", "type", "sort" ] }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, { "type": "null" } ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "status" }, "value": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "by_group" }, "group": { "type": "string" } }, "required": [ "type", "group" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "by_option" }, "option": { "type": "string" } }, "required": [ "type", "option" ] } ], "type": "object" }, { "not": {} } ] } }, "required": [ "type", "value" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "checkbox" }, "value": { "type": "boolean" } }, "required": [ "type", "value" ] }, { "type": "object", "properties": { "type": { "type": "string" }, "value": {} }, "required": [ "type" ], "additionalProperties": {} } ] }, "hidden": { "type": "boolean" }, "emptyHidden": { "type": "boolean" }, "hiddenByDefault": { "type": "boolean" } }, "required": [ "property", "value" ] } }, "filter": {} } } } }, "colorRgbFormat": { "type": "boolean" }, "variant": { "type": "string", "enum": [ "calendarListUpdate", "calendarUpdate" ] } }, "required": [ "provider", "accountId", "calendarId", "calendarData", "variant" ] } } }, "required": [ "mutations" ] } } } }, "responses": { "200": { "description": "Updated calendars", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "calendar": { "type": "object", "properties": { "accountId": { "type": "string" }, "accessRole": { "type": "string", "enum": [ "freeBusyReader", "reader", "writer", "owner" ], "description": "Access level the user has over this calendar." }, "defaultReminders": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarReminder" } }, "etag": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "calendar#calendarList", "calendar#calendarListEntry", "calendar#participant", "calendar#teammate", "calendar#timeCollectionView" ] }, "summary": { "type": "string" }, "provider": { "$ref": "#/components/schemas/DataProvider" }, "notificationSettings": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "const": "email" }, "type": { "type": "string", "enum": [ "eventCreation", "eventChange", "eventCancellation", "eventResponse", "agenda" ] } }, "required": [ "method", "type" ], "additionalProperties": false } } }, "required": [ "notifications" ], "additionalProperties": false }, "conferenceProperties": { "type": "object", "properties": { "allowedConferenceSolutionTypes": { "type": "array", "items": { "type": "string", "enum": [ "eventHangout", "eventNamedHangout", "hangoutsMeet", "teamsForBusiness", "addOn" ] } } }, "additionalProperties": false }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "location": { "type": "string" }, "primary": { "type": "boolean" }, "selected": { "type": "boolean" }, "summaryOverride": { "type": [ "string", "null" ] }, "timeZone": { "type": "string" }, "selfAttendee": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "owner": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" }, "self": { "type": "boolean" } }, "additionalProperties": false }, "backgroundColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "colorId": { "deprecated": true, "type": "string" }, "foregroundColor": { "deprecated": true, "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "orderIndex": { "type": "string" }, "pinned": { "type": "boolean" }, "teammate": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false }, "subtitle": { "type": "string" }, "emoji": { "type": "string" }, "iconUrl": { "type": "string" }, "notionViewType": { "type": "string" }, "notionViewIcon": { "type": "string" }, "notionUrl": { "type": "string" }, "notionPath": { "type": "array", "items": { "type": "string" } }, "notionParentId": { "type": "string" }, "notionStatusPropertyId": { "type": [ "string", "null" ] }, "notionCollection": { "type": "object", "properties": { "id": { "type": "string" }, "properties": {}, "propertyFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "property" ], "additionalProperties": false } }, "propertyVisibilityFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "show", "hide", "hide_if_empty", "section" ] }, { "type": "string" } ] } }, "required": [ "property", "visibility" ], "additionalProperties": false } }, "timePropertyId": { "type": "string" }, "statusFilter": { "type": "string", "enum": [ "all", "notDone" ] }, "dateFilter": { "type": "string", "enum": [ "all", "scheduled", "unscheduled" ] }, "availableViews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "collectionId": { "type": "string" }, "iconPath": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id", "type", "name" ], "additionalProperties": false } }, "groupBy": { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ], "additionalProperties": false } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "property", "type", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, "groupByOverride": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ], "additionalProperties": false } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "property", "type", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, { "type": "null" } ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "status" }, "value": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "by_group" }, "group": { "type": "string" } }, "required": [ "type", "group" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "by_option" }, "option": { "type": "string" } }, "required": [ "type", "option" ], "additionalProperties": false } ], "type": "object" }, { "not": {} } ] } }, "required": [ "type", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "checkbox" }, "value": { "type": "boolean" } }, "required": [ "type", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string" }, "value": {} }, "required": [ "type" ], "additionalProperties": {} } ] }, "hidden": { "type": "boolean" }, "emptyHidden": { "type": "boolean" }, "hiddenByDefault": { "type": "boolean" } }, "required": [ "property", "value" ], "additionalProperties": false } }, "filter": {} }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "accountId", "calendarId" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } } }, "/updateConferencing": { "post": { "operationId": "updateConferencing", "summary": "Update conferencing", "requestBody": { "description": "Update conferencing request", "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "zoom" ] }, "meetingId": { "type": "string" }, "topic": { "type": "string" }, "duration": { "type": "number" }, "timeZone": { "type": "string" }, "startTime": { "type": "string" }, "type": { "type": "string" }, "useV1Behavior": { "type": "boolean" } }, "required": [ "provider", "meetingId" ] } } } }, "responses": { "200": { "description": "Updated conferencing", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "meeting": { "type": "object", "properties": { "id": { "type": "string" }, "password": { "type": "string" }, "joinUrl": { "type": "string" } }, "required": [ "id", "joinUrl" ], "additionalProperties": false } }, "required": [ "status", "meeting" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "failure" }, "statusCode": { "type": "number" }, "response": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "number", "const": 300 }, { "type": "number", "const": 1010 }, { "type": "number", "const": 3000 }, { "type": "number", "const": 3003 }, { "type": "number", "const": 1001 }, { "type": "number", "const": 3001 }, { "type": "number", "const": 3161 } ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "status", "statusCode", "response" ], "additionalProperties": false }, { "type": "object", "properties": { "meeting": { "type": "object", "properties": { "id": { "type": "string" }, "password": { "type": "string" }, "joinUrl": { "type": "string" } }, "required": [ "id", "joinUrl" ], "additionalProperties": false } }, "required": [ "meeting" ], "additionalProperties": false } ] } } } } } } }, "/updateEvents": { "post": { "operationId": "updateEvents", "summary": "Update events", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mutations": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "eventId": { "type": "string" }, "calendarId": { "type": "string" }, "eventData": { "$ref": "#/components/schemas/CalendarEvent" }, "userTimeZone": { "type": "string" }, "sendUpdates": { "type": "string", "enum": [ "all", "none", "externalOnly" ] } }, "required": [ "provider", "accountId", "eventId", "calendarId", "eventData" ] } } }, "required": [ "mutations" ] } } } }, "responses": { "200": { "description": "Updated events", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "event": { "$ref": "#/components/schemas/CalendarEvent" } }, "required": [ "accountId", "calendarId", "event" ], "additionalProperties": false }, { "$ref": "#/components/schemas/DataProviderError" } ] } } } } } } } }, "/rsvpEvent": { "post": { "operationId": "rsvpEvent", "summary": "RSVP to an event", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "eventId": { "type": "string" }, "responseStatus": { "type": "string", "enum": [ "accepted", "declined", "tentative" ] }, "comment": { "type": "string" }, "userTimeZone": { "type": "string" }, "counterProposal": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "end": { "$ref": "#/components/schemas/CalendarEventDateTime" } }, "required": [ "start", "end" ] } }, "required": [ "accountId", "calendarId", "eventId", "responseStatus" ] } } } }, "responses": { "200": { "description": "The event after the RSVP was recorded", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CalendarEvent" } }, "required": [ "event" ], "additionalProperties": false } } } } } } }, "/updateUserSettings": { "post": { "operationId": "updateUserSettings", "summary": "Update user settings", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "properties": { "ai": { "anyOf": [ { "type": "object", "properties": { "notionAccountId": { "type": [ "string", "null" ] } } }, { "type": "null" } ] }, "meetingPrep": { "anyOf": [ { "type": "object", "properties": { "includeAllDayEvents": { "type": [ "boolean", "null" ] }, "includeJustYouEvents": { "type": [ "boolean", "null" ] }, "enabled": { "type": [ "boolean", "null" ] }, "recurrence": { "anyOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "day" }, "interval": { "type": "number", "const": 1 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 } }, "required": [ "frequency", "interval", "hour" ] }, { "type": "null" } ] }, "calendars": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": [ "boolean", "null" ] } } }, { "type": "null" } ] } }, { "type": "null" } ] } }, { "type": "null" } ] } } }, { "type": "null" } ] }, "timeZones": { "anyOf": [ { "type": "object", "properties": { "labels": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "null" ] } }, { "type": "null" } ] }, "recency": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "null" ] } }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "null" ] } }, { "type": "null" } ] }, "primaryId": { "type": [ "string", "null" ] }, "isAutoDetectDisabled": { "type": [ "boolean", "null" ] } } }, { "type": "null" } ] }, "timeFormat": { "anyOf": [ { "type": "string", "enum": [ "12-hour", "24-hour", "system" ] }, { "type": "null" } ] }, "locations": { "anyOf": [ { "type": "object", "properties": { "mapsApp": { "anyOf": [ { "type": "string", "enum": [ "google", "apple" ] }, { "type": "null" } ] } } }, { "type": "null" } ] } } } }, "required": [ "settings" ] } } } }, "responses": { "200": { "description": "Updated user settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "properties": { "ai": { "type": "object", "properties": { "notionAccountId": { "type": "string" } }, "additionalProperties": false }, "meetingPrep": { "type": "object", "properties": { "includeAllDayEvents": { "type": "boolean" }, "includeJustYouEvents": { "type": "boolean" }, "enabled": { "type": "boolean" }, "recurrence": { "type": "object", "properties": { "frequency": { "type": "string", "const": "day" }, "interval": { "type": "number", "const": 1 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 } }, "required": [ "frequency", "interval", "hour" ], "additionalProperties": false }, "calendars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } } } }, "additionalProperties": false }, "timeZones": { "type": "object", "properties": { "labels": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "recency": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "visibility": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "primaryId": { "type": "string" }, "isAutoDetectDisabled": { "type": "boolean" } }, "additionalProperties": false }, "timeFormat": { "type": "string", "enum": [ "12-hour", "24-hour", "system" ] }, "locations": { "type": "object", "properties": { "mapsApp": { "type": "string", "enum": [ "google", "apple" ] } }, "additionalProperties": false } }, "required": [ "timeZones", "timeFormat", "locations" ], "additionalProperties": false } }, "required": [ "settings" ], "additionalProperties": false } } } } } } }, "/getSchedules": { "post": { "operationId": "getSchedules", "summary": "Get participant schedules", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "timeMin": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeMax": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeZone": { "type": "string" }, "emails": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } } }, "required": [ "accountId", "timeMin", "timeMax", "timeZone", "emails" ] } } } }, "responses": { "200": { "description": "First-page participant schedules or an explicit unknown availability marker", "content": { "application/json": { "schema": { "type": "object", "properties": { "schedules": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "availability": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "unknown" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "events" }, "accountId": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "id": { "type": "string" }, "iCalUID": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/CalendarEventType" }, "status": { "type": "string", "enum": [ "confirmed", "tentative", "cancelled" ], "description": "Is an event confirmed, tentative or cancelled? This is different from the user's RSVP" }, "summary": { "type": "string" }, "start": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "end": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "transparency": { "type": "string", "enum": [ "opaque", "transparent" ] } }, "required": [ "accountId", "id" ], "additionalProperties": false } } }, "required": [ "type", "accountId", "events" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "freeBusy" }, "accountId": { "type": "string" }, "busyPeriods": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "id": { "type": "string" }, "start": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "end": { "$ref": "#/components/schemas/CalendarEventDateTime" } }, "required": [ "accountId", "id" ], "additionalProperties": false } } }, "required": [ "type", "accountId", "busyPeriods" ], "additionalProperties": false } ], "type": "object" } }, "required": [ "email", "availability" ], "additionalProperties": false }, "description": "Order is unspecified. Match schedules by email." }, "groups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "isGroup": { "type": "boolean", "const": false } }, "required": [ "isGroup" ], "additionalProperties": false }, { "type": "object", "properties": { "isGroup": { "type": "boolean", "const": true }, "members": { "type": "array", "items": { "type": "string" } }, "isTooBig": { "type": "boolean" } }, "required": [ "isGroup", "members", "isTooBig" ], "additionalProperties": false } ], "type": "object" }, "description": "Group results by requested email. Addresses without a resolved group status are omitted." } }, "required": [ "schedules", "groups" ], "additionalProperties": false } } } } } } }, "/suggestMeetingTimes": { "post": { "operationId": "suggestMeetingTimes", "summary": "Suggest meeting times", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "participantEmails": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "timeMin": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeMax": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeZone": { "type": "string" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "includeParticipantSchedules": { "type": "boolean", "const": true }, "includeFullParticipantSchedules": { "type": "boolean", "const": true }, "maxCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 50 } }, "required": [ "participantEmails", "durationMinutes", "timeMin", "timeMax", "timeZone", "accountId", "calendarId" ] } } } }, "responses": { "200": { "description": "Ranked meeting-time suggestions for the requested participants", "content": { "application/json": { "schema": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "object", "properties": { "startAt": { "type": "string" }, "endAt": { "type": "string" }, "hardEventConflictCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "softEventConflictCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailableParticipants": { "type": "array", "items": { "type": "string" } }, "availableParticipants": { "type": "array", "items": { "type": "string" } }, "softConflictParticipants": { "type": "array", "items": { "type": "string" } }, "unknownStatus": { "type": "array", "items": { "type": "string" } }, "conflictingEvents": { "type": "array", "items": { "type": "object", "properties": { "participantEmail": { "type": "string" }, "eventId": { "type": "string" }, "summary": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/CalendarEventType" }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "conflictType": { "type": "string", "enum": [ "hard", "soft" ] } }, "required": [ "participantEmail", "eventId", "eventType", "conflictType" ], "additionalProperties": false } } }, "required": [ "startAt", "endAt", "hardEventConflictCount", "softEventConflictCount", "unavailableParticipants", "availableParticipants", "softConflictParticipants", "unknownStatus" ], "additionalProperties": false } }, "usedFlexibleDuration": { "type": "boolean" }, "participantSchedules": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "coworkerEmail": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/CalendarEventType" }, "eventStatus": { "type": "string", "enum": [ "confirmed", "tentative", "cancelled" ], "description": "Is an event confirmed, tentative or cancelled? This is different from the user's RSVP" }, "summary": { "type": "string" }, "period": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "DATE" }, "start": { "type": "object", "properties": { "date": { "type": "string" } }, "required": [ "date" ], "additionalProperties": false }, "end": { "type": "object", "properties": { "date": { "type": "string" } }, "required": [ "date" ], "additionalProperties": false } }, "required": [ "type", "start", "end" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "DATE_TIME" }, "start": { "type": "object", "properties": { "dateTime": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "dateTime" ], "additionalProperties": false }, "end": { "type": "object", "properties": { "dateTime": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "dateTime" ], "additionalProperties": false } }, "required": [ "type", "start", "end" ], "additionalProperties": false } ], "type": "object" }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "colors": { "type": "object", "properties": { "background": { "type": "string" }, "foreground": { "type": "string" } }, "additionalProperties": false }, "isTransparent": { "type": "boolean" }, "isMeeting": { "type": "boolean" } }, "required": [ "eventId", "summary", "period", "isTransparent", "isMeeting" ], "additionalProperties": false } } }, "required": [ "accountId", "coworkerEmail", "events" ], "additionalProperties": false } } }, "required": [ "suggestions", "usedFlexibleDuration", "participantSchedules" ], "additionalProperties": false } } } } } } }, "/getSmartEvent": { "post": { "operationId": "getSmartEvent", "summary": "Get a smart calendar event", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string" }, "requestDateTime": { "type": "string" }, "currentEvent": { "type": "object", "properties": { "summary": { "type": "string" }, "period": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "DATE" }, "start": { "type": "object", "properties": { "date": { "type": "string" } }, "required": [ "date" ] }, "end": { "type": "object", "properties": { "date": { "type": "string" } }, "required": [ "date" ] } }, "required": [ "type", "start", "end" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "DATE_TIME" }, "start": { "type": "object", "properties": { "dateTime": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "dateTime" ] }, "end": { "type": "object", "properties": { "dateTime": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "dateTime" ] } }, "required": [ "type", "start", "end" ] } ], "type": "object" }, "recurrenceRule": { "type": "string" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "email": { "type": "string" } } } }, "location": { "type": "string" }, "calendar": { "type": "object", "properties": { "name": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "name" ] } }, "required": [ "period" ] } }, "required": [ "prompt", "requestDateTime" ] } } } }, "responses": { "200": { "description": "Generated Smart Event intent", "content": { "application/json": { "schema": { "type": "object", "properties": { "smartEventIntent": { "type": "object", "properties": { "operations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "person" }, "operation": { "type": "string", "const": "add" }, "reference": { "type": "string" } }, "required": [ "type", "operation", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "location" }, "operation": { "type": "string", "const": "add" }, "reference": { "type": "string" } }, "required": [ "type", "operation", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "recurrence" }, "operation": { "type": "string", "const": "set" }, "reference": { "type": "object", "properties": { "interval": { "type": "number" }, "pattern": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "daily" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "weekdays": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] } }, "required": [ "kind", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "monthly-by-month-day" }, "monthDays": { "anyOf": [ { "type": "array", "items": { "type": "number" } }, { "type": "null" } ] } }, "required": [ "kind", "monthDays" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "monthly-by-weekday" }, "ordinal": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 }, { "type": "number", "const": 3 }, { "type": "number", "const": 4 }, { "type": "number", "const": 5 }, { "type": "number", "const": -1 } ] }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, "required": [ "kind", "ordinal", "weekday" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "yearly" } }, "required": [ "kind" ], "additionalProperties": false } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "never" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "until" }, "date": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] } }, "required": [ "kind", "date" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "count" }, "count": { "type": "number" } }, "required": [ "kind", "count" ], "additionalProperties": false } ] } }, "required": [ "interval", "pattern", "end" ], "additionalProperties": false } }, "required": [ "type", "operation", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "time" }, "operation": { "type": "string", "const": "edit" }, "reference": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "timed" }, "date": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "startTime": { "anyOf": [ { "type": "object", "properties": { "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "hour", "minute" ], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "end-time" }, "date": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "time": { "type": "object", "properties": { "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "hour", "minute" ], "additionalProperties": false } }, "required": [ "kind", "date", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "duration" }, "minutes": { "type": "number" } }, "required": [ "kind", "minutes" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "timeZoneReference": { "type": [ "string", "null" ] } }, "required": [ "kind", "date", "startTime", "end", "timeZoneReference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all-day" }, "date": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, "endDate": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "kind", "date", "endDate" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date" }, "date": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, "endDate": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-days" }, "days": { "type": "number" } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative-weeks" }, "weeks": { "type": "number" } }, "required": [ "kind", "weeks" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekday" }, "weekday": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "qualifier": { "type": "string", "enum": [ "bare", "this", "next" ] } }, "required": [ "kind", "weekday", "qualifier" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar-date" }, "year": { "type": [ "number", "null" ] }, "month": { "type": "number" }, "day": { "type": "number" } }, "required": [ "kind", "year", "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric-date" }, "reference": { "type": "string" } }, "required": [ "kind", "reference" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "kind", "date", "endDate" ], "additionalProperties": false } ] } }, "required": [ "type", "operation", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "title" }, "operation": { "type": "string", "const": "set" }, "reference": { "type": "string" } }, "required": [ "type", "operation", "reference" ], "additionalProperties": false } ] } } }, "required": [ "operations" ], "additionalProperties": false }, "inferenceTraceId": { "type": "string" }, "userFeedbackEnabled": { "type": "boolean" } }, "required": [ "smartEventIntent", "inferenceTraceId", "userFeedbackEnabled" ], "additionalProperties": false } } } } } } }, "/submitSmartEventFeedback": { "post": { "operationId": "submitSmartEventFeedback", "summary": "Submit feedback about a Smart Event", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "feedbackType": { "type": "string", "const": "thumbs_down" }, "userPrompt": { "type": "string" }, "comment": { "type": "string" }, "calendarEventSnapshot": { "$ref": "#/components/schemas/CalendarEvent" }, "traceId": { "type": "string" } }, "required": [ "feedbackType", "userPrompt", "calendarEventSnapshot", "traceId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Braintrust debug URL after feedback is accepted for processing", "content": { "application/json": { "schema": { "type": "object", "properties": { "braintrustDebugUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } } } } } } }, "/getMeetingPrepState": { "post": { "operationId": "getMeetingPrepState", "summary": "Get Meeting Prep state for one event", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventRef": { "$ref": "#/components/schemas/CalendarEventReference" } }, "required": [ "eventRef" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The current Meeting Prep state, if one exists", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "inProgress" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "workflowInfo": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1 }, "threadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "threadUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "required": [ "type", "startedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "ready" }, "completedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "result": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "prep": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "keyPoints": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 }, "sourceIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "text" ], "additionalProperties": false } }, "people": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "role": { "type": "string", "minLength": 1 }, "summary": { "type": "string", "minLength": 1 }, "sourceIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "name", "summary" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" }, "kind": { "type": "string", "enum": [ "notion", "slack", "web", "calendar" ] } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "required": [ "title", "keyPoints", "people" ], "additionalProperties": false } }, "required": [ "version", "prep" ], "additionalProperties": false }, "viewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "workflowInfo": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1 }, "threadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "threadUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "required": [ "type", "completedAt", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "failed" }, "failedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "reason": { "type": "string", "minLength": 1 }, "workflowInfo": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1 }, "threadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "threadUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "required": [ "type", "failedAt", "reason" ], "additionalProperties": false } ], "type": "object" } }, "additionalProperties": false } } } } } } }, "/markMeetingPrepViewed": { "post": { "operationId": "markMeetingPrepViewed", "summary": "Mark a Meeting Prep attempt as viewed", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventRef": { "$ref": "#/components/schemas/CalendarEventReference" } }, "required": [ "eventRef" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The view was recorded or the attempt is no longer ready", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } } } }, "/createMeetingPreps": { "post": { "operationId": "createMeetingPreps", "summary": "Start Meeting Prep for a batch of events", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventReference" } } }, "required": [ "events" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Meeting Prep creation acknowledgement", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } } } }, "/sendMeetingPrepMessage": { "post": { "operationId": "sendMeetingPrepMessage", "summary": "Send a message to an existing Meeting Prep", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventRef": { "$ref": "#/components/schemas/CalendarEventReference" }, "message": { "type": "string", "minLength": 1 }, "clientEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "eventRef", "message", "clientEventId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Meeting Prep message acknowledgement", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } } } } }, "components": { "schemas": { "CalendarEventType": { "type": "string", "enum": [ "fromGmail", "default", "focusTime", "outOfOffice", "birthday", "availability" ], "description": "What kind of event is it? Standard, out of office, birthday..." }, "CalendarEventReference": { "type": "object", "properties": { "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "eventId": { "type": "string" } }, "required": [ "calendar", "eventId" ] }, "CalendarReference": { "type": "object", "properties": { "accountId": { "type": "string" }, "calendarId": { "type": "string" } }, "required": [ "accountId", "calendarId" ] }, "PublicApiErrorCode": { "type": "string", "enum": [ "accountAlreadyPrimary", "accountDoesNotBelongToUser", "accountEmailMismatch", "accountNotFound", "accountNotConnected", "accountRemovedFromGoogle", "accountRequiresReconnection", "applicationRequestTimeout", "archivedNotionAncestor", "archivedNotionBlock", "authProviderMissingUserInfo", "displayNameEmpty", "displayNameInvalidCharacters", "displayNameInvalidLength", "emailDoesNotMatchSelectedCronAccount", "googleAccountAdd", "googleAccountAdditionFailed", "holdNotFound", "invalidAuthProvider", "invalidAuthProviderInRequest", "invalidDate", "invalidGooglePushNotification", "invalidFileUrl", "invalidNotionWorkspaceLinkCode", "invalidPeopleCursor", "invalidToken", "locationDetailsUnavailable", "missingParameter", "noAuthClientForAccount", "notionAIWorkspaceNotConfigured", "notionAICreditLimitReached", "notionAICreditLimitReachedWithUpsell", "notionBlockLimitExceeded", "notionCalendarUserUnavailable", "notionDatabaseLimitReached", "notionLocationNotFound", "notionPageArchived", "notionPageParentArchived", "notionPagePropertyNotFound", "notionWorkspaceDisconnected", "notionWorkspaceNotSpecified", "oauthCodeExchange", "oauthCodeExchangeFailed", "oauthCodeVerificationFailed", "outlookMailboxNotAccessible", "outlookUserAgentRestricted", "primaryAccountDelete", "removeAccount", "referralCodeUnavailable", "resourceNotFound", "schedulingLinkAliasTaken", "schedulingLinkCalendarInvalid", "schedulingLinkExpired", "schedulingLinkMeetingCanceled", "schedulingLinkMeetingNotFound", "schedulingLinkMeetingTimeInvalid", "schedulingLinkNoUpcomingTimes", "schedulingLinkNotFound", "synchronizedCalendarNotFound", "synchronizedEventNotFound", "unexpected", "userNotAuthorized", "userNotFound", "usernameEmpty", "usernameGeneration", "usernameInvalidCharacters", "usernameInvalidLength", "usernameMissingLetter", "usernameTaken" ] }, "DataProvider": { "type": "string", "enum": [ "google", "notion", "icloud", "outlook" ] }, "Account": { "type": "object", "properties": { "id": { "type": "string" }, "providerName": { "$ref": "#/components/schemas/AccountProviderName" }, "createdAt": { "type": "string" }, "primary": { "type": "boolean" }, "email": { "type": "string" }, "displayName": { "type": "string" }, "customValue": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "profilePhotoURL": { "type": "string" }, "providerUserId": { "type": "string" }, "hostedDomain": { "type": "string" }, "orgDomains": { "type": "array", "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string" } }, "info": { "anyOf": [ { "type": "object", "properties": { "notionUserId": { "type": "string" }, "notionWorkspaceId": { "type": "string" }, "notionUserDisplayName": { "type": [ "string", "null" ] }, "notionWorkspaceSettings": { "anyOf": [ { "type": "object", "properties": { "isAiEnabled": { "type": "boolean" }, "isTranscriptionEnabled": { "type": "boolean" }, "meetingNotesSettings": { "type": "object", "properties": { "defaultLocation": { "type": "object", "properties": { "block": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ] }, "collection": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ] } }, "required": [ "block" ] }, "disableAutoShare": { "type": "boolean" } } }, "agentPersonalizationSettings": { "type": "object", "properties": { "name": { "type": "string" }, "customizationItems": { "type": "array", "items": { "type": "string", "enum": [ "baseball-cap", "bow", "cat", "cherry", "cowboy", "crown", "duck", "firefighter", "flower", "glasses", "headphone", "leaf", "magician", "mustache", "paprika", "pencil", "propeller", "safety-hat", "scarf" ] } }, "contextPageId": { "type": "string" } } }, "desktopRegistration": { "type": "object", "properties": { "mac": { "type": "boolean" }, "windows": { "type": "boolean" } }, "required": [ "mac", "windows" ] } }, "required": [ "isAiEnabled", "isTranscriptionEnabled", "meetingNotesSettings" ] }, { "type": "null" } ] }, "autoAddMeetingNotes": { "type": [ "boolean", "null" ] }, "displayName": { "type": [ "string", "null" ] } }, "required": [ "notionUserId", "notionWorkspaceId" ] }, { "type": "object", "properties": { "conferencing": { "anyOf": [ { "type": "object", "properties": { "providerName": { "type": "string", "enum": [ "customConferencing", "googleMeet", "microsoftTeams", "zoom" ] }, "accountId": { "type": "string" }, "displayName": { "type": "string" } }, "required": [ "providerName" ] }, { "type": "null" } ] }, "notionAccountId": { "type": [ "string", "null" ] }, "displayName": { "type": [ "string", "null" ] }, "orgDomains": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "orderIndex": { "type": "string" }, "collapsed": { "type": "boolean" }, "joinMeetingActionSettings": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "const": "join_only" } }, "required": [ "action" ] }, { "type": "object", "properties": { "action": { "type": "string", "const": "join_and_transcribe" }, "appliedFilters": { "type": "object", "properties": { "organizedByMe": { "type": "boolean" }, "oneOnOne": { "type": "boolean" }, "createdNoteFor": { "type": "boolean" }, "recurrencePreviouslyTranscribed": { "type": "boolean" } } } }, "required": [ "action", "appliedFilters" ] } ], "type": "object" }, { "type": "null" } ] } } } ] }, "status": { "type": "string", "const": "disconnected" }, "capabilities": { "$ref": "#/components/schemas/AccountCapabilities" }, "orderIndex": { "type": "string" } }, "required": [ "id", "providerName", "createdAt", "displayName" ] }, "AccountProviderName": { "type": "string", "enum": [ "google", "notion", "icloud", "zoom", "outlook", "customConferencing" ] }, "AccountCapabilities": { "type": "object", "properties": { "readCalendars": { "type": "boolean", "description": "Does this account expose any calendars?" }, "readCalendarResources": { "type": "boolean", "description": "Can this account expose any calendar resource (e.g. rooms, equipment, etc.)?" }, "readFreeBusy": { "type": "boolean", "description": "Can this account read free/busy information for calendars?" }, "readEvents": { "type": "boolean", "description": "Can we read calendar events from calendars of this account?" }, "readWorkingLocations": { "type": "boolean", "description": "Can we read scheduled working locations from this account?" }, "readOrgEvents": { "type": "boolean", "description": "Can we read calendar events from teammates of this account?" }, "searchEvents": { "type": "boolean", "description": "Can we use a text search query to find events in the calendars of this account?" }, "syncEvents": { "type": "boolean", "description": "Can we incrementally sync calendar events from calendars of this account?" }, "writeEvents": { "type": "boolean", "description": "Can we write events in some calendars of this account? Calendars themselves might have their own set of restrictions." }, "blockEvents": { "type": "boolean", "description": "Can calendars in this account be used as a blocking destination, when blocking events from a calendar to another?" }, "supportHtmlDescriptions": { "type": "boolean", "description": "Can calendar event descriptions contain HTML?" }, "readContacts": { "type": "boolean", "description": "Does this account expose contacts?" }, "readDirectory": { "type": "boolean", "description": "Does this account expose a people directory (e.g. a corporation's employee directory)?" }, "readGroups": { "type": "boolean", "description": "Can this account read directory groups" }, "includeInMeetingPrep": { "type": "boolean" }, "generateMeetingPrep": { "type": "boolean" }, "takeMeetingNotes": { "type": "boolean", "description": "" } }, "required": [ "readCalendars", "readCalendarResources", "readFreeBusy", "readEvents", "readWorkingLocations", "readOrgEvents", "searchEvents", "syncEvents", "writeEvents", "blockEvents", "supportHtmlDescriptions", "readContacts", "readDirectory", "readGroups", "includeInMeetingPrep", "generateMeetingPrep", "takeMeetingNotes" ], "description": "What the user has access to with this account" }, "CalendarReminder": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "email", "popup" ] }, "minutes": { "type": "number" } }, "required": [ "method", "minutes" ] }, "CalendarEvent": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "sequence": { "type": "number" }, "anyoneCanAddSelf": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "fileUrl": { "type": "string" }, "iconLink": { "type": "string" }, "title": { "type": "string" }, "mimeType": { "type": "string" }, "fileId": { "type": "string" } }, "required": [ "fileUrl", "iconLink", "title" ] } }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "additionalGuests": { "type": "number" }, "comment": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "optional": { "type": [ "boolean", "null" ] }, "organizer": { "type": "boolean" }, "resource": { "type": "boolean" }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "self": { "type": "boolean" }, "groupMembers": { "type": "array", "items": { "type": "string" } } }, "required": [ "responseStatus" ] } }, "colorId": { "type": [ "string", "null" ] }, "conferenceData": { "anyOf": [ { "type": "object", "properties": { "conferenceId": { "type": [ "string", "null" ] }, "createRequest": { "type": "object", "properties": { "requestId": { "type": "string" }, "conferenceSolutionKey": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "eventHangout", "eventNamedHangout", "hangoutsMeet", "teamsForBusiness", "addOn" ] } }, "required": [ "type" ] }, "status": { "type": "object", "properties": { "statusCode": { "type": "string", "enum": [ "pending", "success", "failure" ] } }, "required": [ "statusCode" ] }, "entryPoints": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "accessCode": { "type": "string" }, "entryPointType": { "type": "string", "enum": [ "video", "phone", "sip", "more" ] }, "label": { "type": "string" }, "meetingCode": { "type": "string" }, "passcode": { "type": "string" }, "password": { "type": "string" }, "pin": { "type": "string" }, "notes": { "type": "string" }, "signature": { "type": "string" } }, "required": [ "uri" ] } } }, "required": [ "requestId" ] }, "conferenceSolution": { "type": "object", "properties": { "iconUri": { "type": "string" }, "key": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "eventHangout", "eventNamedHangout", "hangoutsMeet", "teamsForBusiness", "addOn" ] } }, "required": [ "type" ] }, "name": { "type": "string" } }, "required": [ "key", "name" ] }, "entryPoints": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "accessCode": { "type": "string" }, "entryPointType": { "type": "string", "enum": [ "video", "phone", "sip", "more" ] }, "label": { "type": "string" }, "meetingCode": { "type": "string" }, "passcode": { "type": "string" }, "password": { "type": "string" }, "pin": { "type": "string" }, "notes": { "type": "string" }, "signature": { "type": "string" } }, "required": [ "uri" ] } }, "notes": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] }, "parameters": { "anyOf": [ { "type": "object", "properties": { "addOnParameters": { "type": "object", "properties": { "parameters": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ] } } } } }, { "type": "null" } ] } } }, { "type": "null" } ] }, "created": { "type": "string" }, "creator": { "type": "object", "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "self": { "type": "boolean" } } }, "description": { "type": [ "string", "null" ] }, "end": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "endTimeUnspecified": { "type": "boolean" }, "etag": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/CalendarEventType" }, "extendedProperties": { "type": "object", "properties": { "private": { "type": "object", "properties": { "cron.sync": { "anyOf": [ { "type": "string", "const": "true" }, { "type": "null" } ] }, "cron.calendarSync": { "anyOf": [ { "type": "string", "const": "true" }, { "type": "null" } ] }, "cron.syncOriginalEventId": { "type": [ "string", "null" ] }, "cron.syncOriginalCalendarId": { "type": [ "string", "null" ] }, "cron.syncOriginalAccountId": { "type": [ "string", "null" ] }, "cron.syncRecurringType": { "anyOf": [ { "type": "string", "enum": [ "all", "single" ] }, { "type": "null" } ] }, "cron.syncVisibility": { "anyOf": [ { "type": "string", "enum": [ "public", "private" ] }, { "type": "null" } ] }, "cron.zoomMeeting": { "type": [ "string", "null" ] }, "reclaim.personalSync.eventId": { "type": [ "string", "null" ] }, "mayday_mirrored_task_id": { "type": [ "string", "null" ] }, "mayday_task_id": { "type": [ "string", "null" ] } }, "additionalProperties": { "type": [ "string", "null" ] } }, "shared": { "type": "object", "properties": { "cron.holdGroup.id": { "type": [ "string", "null" ] }, "cron.holdGroup.shortId": { "type": [ "string", "null" ] }, "cron.holdGroup.slotId": { "type": [ "string", "null" ] }, "cron.holdGroup.recipientName": { "type": [ "string", "null" ] }, "motionUserId": { "type": [ "string", "null" ] }, "motionSourceCalendarId": { "type": [ "string", "null" ] }, "motionSourceEventId": { "type": [ "string", "null" ] } }, "additionalProperties": { "type": [ "string", "null" ] } } } }, "gadget": { "type": "object", "properties": { "display": { "type": "string", "enum": [ "icon", "chip" ] }, "height": { "type": "number" }, "iconLink": { "type": "string" }, "link": { "type": "string" }, "preferences": { "type": "object", "properties": { "key": { "type": "string" } } }, "title": { "type": "string" }, "type": { "type": "string" }, "width": { "type": "number" } } }, "guestsCanInviteOthers": { "type": "boolean" }, "guestsCanModify": { "type": "boolean" }, "guestsCanSeeOtherGuests": { "type": "boolean" }, "hangoutLink": { "type": "string" }, "htmlLink": { "type": "string" }, "iCalUID": { "type": "string" }, "location": { "type": [ "string", "null" ] }, "locked": { "type": "boolean" }, "organizer": { "type": "object", "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "self": { "type": "boolean" } } }, "originalStartTime": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "privateCopy": { "type": "boolean" }, "recurrence": { "type": "array", "items": { "type": "string" } }, "recurringEventId": { "type": "string" }, "reminders": { "$ref": "#/components/schemas/CalendarEventReminder" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "title", "url" ] }, "start": { "$ref": "#/components/schemas/CalendarEventDateTime" }, "status": { "type": "string", "enum": [ "confirmed", "tentative", "cancelled" ], "description": "Is an event confirmed, tentative or cancelled? This is different from the user's RSVP" }, "summary": { "type": "string" }, "transparency": { "type": "string", "enum": [ "opaque", "transparent" ] }, "updated": { "type": "string" }, "visibility": { "type": "string", "enum": [ "default", "public", "private", "confidential" ] }, "attendeesOmitted": { "type": "boolean" }, "outOfOfficeProperties": { "type": "object", "properties": { "autoDeclineMode": { "anyOf": [ { "type": "string", "enum": [ "declineNone", "declineAllConflictingInvitations", "declineOnlyNewConflictingInvitations" ] }, { "type": "null" } ] }, "declineMessage": { "type": [ "string", "null" ] } } }, "focusTimeProperties": { "type": "object", "properties": { "autoDeclineMode": { "anyOf": [ { "type": "string", "enum": [ "declineNone", "declineAllConflictingInvitations", "declineOnlyNewConflictingInvitations" ] }, { "type": "null" } ] }, "chatStatus": { "anyOf": [ { "type": "string", "enum": [ "available", "doNotDisturb" ] }, { "type": "null" } ] }, "declineMessage": { "type": [ "string", "null" ] } } }, "workingLocationProperties": { "type": "object", "properties": { "customLocation": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string" } } }, { "type": "null" } ] }, "homeOffice": { "anyOf": [ {}, { "type": "null" } ] }, "officeLocation": { "anyOf": [ { "type": "object", "properties": { "buildingId": { "type": "string" }, "deskId": { "type": "string" }, "floorId": { "type": "string" }, "floorSectionId": { "type": "string" }, "label": { "type": "string" } } }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "homeOffice", "officeLocation", "customLocation" ] }, { "type": "null" } ] } } }, "responseStatus": { "type": "string", "enum": [ "needsAction", "accepted", "declined", "tentative" ], "description": "The calendar user's RSVP status" }, "movingFromAccountId": { "type": "string" }, "movingFromCalendarId": { "type": "string" }, "movingFromProvider": { "$ref": "#/components/schemas/DataProvider" }, "movingFromEventId": { "type": "string" }, "movingFromEventType": { "type": "string", "enum": [ "default", "focusTime", "outOfOffice", "birthday", "availability" ] }, "movingFromHoldGroupId": { "type": "string" }, "notionIcon": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "emoji" }, "emoji": { "type": "string" } }, "required": [ "type", "emoji" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "external" }, "url": { "type": "string" } }, "required": [ "type", "url" ] } ], "type": "object" }, { "type": "null" } ] }, "notionUrl": { "type": "string" }, "notionTitleHasRichText": { "type": "boolean" }, "holdGroupId": { "type": "string" }, "provider": { "$ref": "#/components/schemas/DataProvider" }, "accountId": { "type": "string" }, "calendarId": { "type": "string" }, "notionPage": { "type": "object", "properties": { "properties": {} } } }, "required": [ "id", "accountId", "calendarId" ] }, "CalendarEventReminder": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarReminder" } }, "useDefault": { "type": "boolean" } } }, "CalendarEventDateTime": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "dateTime": { "type": [ "string", "null" ] }, "timeZone": { "type": [ "string", "null" ] } } }, "DataProviderError": { "oneOf": [ { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/PublicApiErrorCode" }, "errorMessage": { "type": "string" }, "messageId": { "type": "string", "enum": [ "holdCreateError", "holdUpdateError", "holdDeleteError", "holdNotFoundError", "holdDeletedError", "holdExpiredError", "holdDuplicateAliasError", "holdNoUpcomingTimeRangesError", "holdInvalidCalendarError", "holdInvalidMeetingTimeError", "holdEventCreateError", "holdEventUpdateError", "holdEventRescheduleError", "holdEventCancelError", "holdEventNotFoundError", "holdEventCanceledError", "timeoutError", "basicSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "detailedSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "cannotDeletePhotoError", "invalidFileConfigurationError", "fileUrlIsInvalidError", "noFileFoundError", "resourceNotFoundError", "displayNameEmptyError", "displayNameInvalidCharactersError", "displayNameInvalidLengthError", "invalidNotionWorkspaceLinkCodeError", "invalidPeopleCursorError", "locationDetailsUnavailableError", "unsupportedImageTypeError", "imageTooBigError", "somethingWentWrongError", "zoomHostAccountNotFoundError", "accountNotFoundError", "userNotFoundError", "userNotAuthorizedError", "accountAlreadyPrimaryError", "accountAlreadyPrimaryErrorNotionCalendar", "primaryAccountDeleteError", "noPrimaryAccountFoundError", "accountRemovedFromGoogleError", "synchronizedEventDoesNotExistError", "invalidResourceIdError", "unableToFindOrCreateCalendarError", "unableToFindOrCreateUserError", "unableToFindOrCreateAccountError", "notionWorkspaceNotSpecifiedError", "fileExtensionMissingError", "fileExtensionNotAllowedError", "emailDoesNotMatchGoogleAccountError", "accountNotConnectedError", "missingParameterError", "oAuthCodeExchangeError", "oAuthCodeVerifyError", "authProviderMissingUserInfoError", "invalidGooglePushNotificationError", "usernameTakenError", "usernameEmptyError", "usernameInvalidCharactersError", "usernameInvalidLengthError", "usernameMissingLetterError", "apiTokenInvalidError", "accountRequiresReconnectingError", "outlookUserAgentRestrictedError", "outlookMailboxNotAccessibleError", "noAuthClientForAccountError", "createAccountError", "removeAccountError", "invalidDateError", "referralCodeGenerationError", "referralUserAlreadyExistsError", "referralLimitReachedError", "colorFetchError", "usernameGenerationError", "googleAccountAddError", "accountDoesNotBelongToUserError", "invalidAuthProviderInRequestError", "emailDoesNotMatchSelectedCronAccountError", "emailDoesNotMatchSelectedCronAccountErrorNotionCalendar", "maximumNotionDatabaseCountReached", "notionBlockLimitExceededError", "archivedNotionBlockError", "archivedNotionAncestorError", "notionAuthorizationFailed", "notionAIWorkspaceNotConfiguredError", "notionAICreditLimitReachedError", "notionLocationNotFoundError", "updateArchivedNotionPageError", "updatePageWithArchivedParentError", "notionPagePropertyDoesNotExistError" ] }, "intlMessage": { "type": "string" }, "accountId": { "type": "string" }, "resourceId": { "type": "string" }, "statusCode": { "type": "number" }, "isRecoverable": { "type": "boolean" }, "requiresReauthorization": { "type": "boolean" }, "provider": { "type": "string", "const": "google" }, "googleError": { "type": "object", "properties": { "accountId": { "type": "string" }, "resourceId": { "type": "string" }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "number" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "reason": { "type": "string" }, "message": { "type": "string" }, "locationType": { "type": "string" }, "location": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "error": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "code", "errors", "response", "params" ], "additionalProperties": false }, {} ] } }, "required": [ "accountId", "error" ], "additionalProperties": false } }, "required": [ "errorMessage", "accountId", "provider" ], "additionalProperties": false }, { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/PublicApiErrorCode" }, "errorMessage": { "type": "string" }, "messageId": { "type": "string", "enum": [ "holdCreateError", "holdUpdateError", "holdDeleteError", "holdNotFoundError", "holdDeletedError", "holdExpiredError", "holdDuplicateAliasError", "holdNoUpcomingTimeRangesError", "holdInvalidCalendarError", "holdInvalidMeetingTimeError", "holdEventCreateError", "holdEventUpdateError", "holdEventRescheduleError", "holdEventCancelError", "holdEventNotFoundError", "holdEventCanceledError", "timeoutError", "basicSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "detailedSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "cannotDeletePhotoError", "invalidFileConfigurationError", "fileUrlIsInvalidError", "noFileFoundError", "resourceNotFoundError", "displayNameEmptyError", "displayNameInvalidCharactersError", "displayNameInvalidLengthError", "invalidNotionWorkspaceLinkCodeError", "invalidPeopleCursorError", "locationDetailsUnavailableError", "unsupportedImageTypeError", "imageTooBigError", "somethingWentWrongError", "zoomHostAccountNotFoundError", "accountNotFoundError", "userNotFoundError", "userNotAuthorizedError", "accountAlreadyPrimaryError", "accountAlreadyPrimaryErrorNotionCalendar", "primaryAccountDeleteError", "noPrimaryAccountFoundError", "accountRemovedFromGoogleError", "synchronizedEventDoesNotExistError", "invalidResourceIdError", "unableToFindOrCreateCalendarError", "unableToFindOrCreateUserError", "unableToFindOrCreateAccountError", "notionWorkspaceNotSpecifiedError", "fileExtensionMissingError", "fileExtensionNotAllowedError", "emailDoesNotMatchGoogleAccountError", "accountNotConnectedError", "missingParameterError", "oAuthCodeExchangeError", "oAuthCodeVerifyError", "authProviderMissingUserInfoError", "invalidGooglePushNotificationError", "usernameTakenError", "usernameEmptyError", "usernameInvalidCharactersError", "usernameInvalidLengthError", "usernameMissingLetterError", "apiTokenInvalidError", "accountRequiresReconnectingError", "outlookUserAgentRestrictedError", "outlookMailboxNotAccessibleError", "noAuthClientForAccountError", "createAccountError", "removeAccountError", "invalidDateError", "referralCodeGenerationError", "referralUserAlreadyExistsError", "referralLimitReachedError", "colorFetchError", "usernameGenerationError", "googleAccountAddError", "accountDoesNotBelongToUserError", "invalidAuthProviderInRequestError", "emailDoesNotMatchSelectedCronAccountError", "emailDoesNotMatchSelectedCronAccountErrorNotionCalendar", "maximumNotionDatabaseCountReached", "notionBlockLimitExceededError", "archivedNotionBlockError", "archivedNotionAncestorError", "notionAuthorizationFailed", "notionAIWorkspaceNotConfiguredError", "notionAICreditLimitReachedError", "notionLocationNotFoundError", "updateArchivedNotionPageError", "updatePageWithArchivedParentError", "notionPagePropertyDoesNotExistError" ] }, "intlMessage": { "type": "string" }, "accountId": { "type": "string" }, "resourceId": { "type": "string" }, "statusCode": { "type": "number" }, "isRecoverable": { "type": "boolean" }, "requiresReauthorization": { "type": "boolean" }, "provider": { "type": "string", "const": "notion" } }, "required": [ "errorMessage", "accountId", "provider" ], "additionalProperties": false }, { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/PublicApiErrorCode" }, "errorMessage": { "type": "string" }, "messageId": { "type": "string", "enum": [ "holdCreateError", "holdUpdateError", "holdDeleteError", "holdNotFoundError", "holdDeletedError", "holdExpiredError", "holdDuplicateAliasError", "holdNoUpcomingTimeRangesError", "holdInvalidCalendarError", "holdInvalidMeetingTimeError", "holdEventCreateError", "holdEventUpdateError", "holdEventRescheduleError", "holdEventCancelError", "holdEventNotFoundError", "holdEventCanceledError", "timeoutError", "basicSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "detailedSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "cannotDeletePhotoError", "invalidFileConfigurationError", "fileUrlIsInvalidError", "noFileFoundError", "resourceNotFoundError", "displayNameEmptyError", "displayNameInvalidCharactersError", "displayNameInvalidLengthError", "invalidNotionWorkspaceLinkCodeError", "invalidPeopleCursorError", "locationDetailsUnavailableError", "unsupportedImageTypeError", "imageTooBigError", "somethingWentWrongError", "zoomHostAccountNotFoundError", "accountNotFoundError", "userNotFoundError", "userNotAuthorizedError", "accountAlreadyPrimaryError", "accountAlreadyPrimaryErrorNotionCalendar", "primaryAccountDeleteError", "noPrimaryAccountFoundError", "accountRemovedFromGoogleError", "synchronizedEventDoesNotExistError", "invalidResourceIdError", "unableToFindOrCreateCalendarError", "unableToFindOrCreateUserError", "unableToFindOrCreateAccountError", "notionWorkspaceNotSpecifiedError", "fileExtensionMissingError", "fileExtensionNotAllowedError", "emailDoesNotMatchGoogleAccountError", "accountNotConnectedError", "missingParameterError", "oAuthCodeExchangeError", "oAuthCodeVerifyError", "authProviderMissingUserInfoError", "invalidGooglePushNotificationError", "usernameTakenError", "usernameEmptyError", "usernameInvalidCharactersError", "usernameInvalidLengthError", "usernameMissingLetterError", "apiTokenInvalidError", "accountRequiresReconnectingError", "outlookUserAgentRestrictedError", "outlookMailboxNotAccessibleError", "noAuthClientForAccountError", "createAccountError", "removeAccountError", "invalidDateError", "referralCodeGenerationError", "referralUserAlreadyExistsError", "referralLimitReachedError", "colorFetchError", "usernameGenerationError", "googleAccountAddError", "accountDoesNotBelongToUserError", "invalidAuthProviderInRequestError", "emailDoesNotMatchSelectedCronAccountError", "emailDoesNotMatchSelectedCronAccountErrorNotionCalendar", "maximumNotionDatabaseCountReached", "notionBlockLimitExceededError", "archivedNotionBlockError", "archivedNotionAncestorError", "notionAuthorizationFailed", "notionAIWorkspaceNotConfiguredError", "notionAICreditLimitReachedError", "notionLocationNotFoundError", "updateArchivedNotionPageError", "updatePageWithArchivedParentError", "notionPagePropertyDoesNotExistError" ] }, "intlMessage": { "type": "string" }, "accountId": { "type": "string" }, "resourceId": { "type": "string" }, "statusCode": { "type": "number" }, "isRecoverable": { "type": "boolean" }, "requiresReauthorization": { "type": "boolean" }, "provider": { "type": "string", "const": "icloud" } }, "required": [ "errorMessage", "accountId", "provider" ], "additionalProperties": false }, { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/PublicApiErrorCode" }, "errorMessage": { "type": "string" }, "messageId": { "type": "string", "enum": [ "holdCreateError", "holdUpdateError", "holdDeleteError", "holdNotFoundError", "holdDeletedError", "holdExpiredError", "holdDuplicateAliasError", "holdNoUpcomingTimeRangesError", "holdInvalidCalendarError", "holdInvalidMeetingTimeError", "holdEventCreateError", "holdEventUpdateError", "holdEventRescheduleError", "holdEventCancelError", "holdEventNotFoundError", "holdEventCanceledError", "timeoutError", "basicSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "detailedSomethingIsWrongeReachoutToSupportErrorNotionCalendar", "cannotDeletePhotoError", "invalidFileConfigurationError", "fileUrlIsInvalidError", "noFileFoundError", "resourceNotFoundError", "displayNameEmptyError", "displayNameInvalidCharactersError", "displayNameInvalidLengthError", "invalidNotionWorkspaceLinkCodeError", "invalidPeopleCursorError", "locationDetailsUnavailableError", "unsupportedImageTypeError", "imageTooBigError", "somethingWentWrongError", "zoomHostAccountNotFoundError", "accountNotFoundError", "userNotFoundError", "userNotAuthorizedError", "accountAlreadyPrimaryError", "accountAlreadyPrimaryErrorNotionCalendar", "primaryAccountDeleteError", "noPrimaryAccountFoundError", "accountRemovedFromGoogleError", "synchronizedEventDoesNotExistError", "invalidResourceIdError", "unableToFindOrCreateCalendarError", "unableToFindOrCreateUserError", "unableToFindOrCreateAccountError", "notionWorkspaceNotSpecifiedError", "fileExtensionMissingError", "fileExtensionNotAllowedError", "emailDoesNotMatchGoogleAccountError", "accountNotConnectedError", "missingParameterError", "oAuthCodeExchangeError", "oAuthCodeVerifyError", "authProviderMissingUserInfoError", "invalidGooglePushNotificationError", "usernameTakenError", "usernameEmptyError", "usernameInvalidCharactersError", "usernameInvalidLengthError", "usernameMissingLetterError", "apiTokenInvalidError", "accountRequiresReconnectingError", "outlookUserAgentRestrictedError", "outlookMailboxNotAccessibleError", "noAuthClientForAccountError", "createAccountError", "removeAccountError", "invalidDateError", "referralCodeGenerationError", "referralUserAlreadyExistsError", "referralLimitReachedError", "colorFetchError", "usernameGenerationError", "googleAccountAddError", "accountDoesNotBelongToUserError", "invalidAuthProviderInRequestError", "emailDoesNotMatchSelectedCronAccountError", "emailDoesNotMatchSelectedCronAccountErrorNotionCalendar", "maximumNotionDatabaseCountReached", "notionBlockLimitExceededError", "archivedNotionBlockError", "archivedNotionAncestorError", "notionAuthorizationFailed", "notionAIWorkspaceNotConfiguredError", "notionAICreditLimitReachedError", "notionLocationNotFoundError", "updateArchivedNotionPageError", "updatePageWithArchivedParentError", "notionPagePropertyDoesNotExistError" ] }, "intlMessage": { "type": "string" }, "accountId": { "type": "string" }, "resourceId": { "type": "string" }, "statusCode": { "type": "number" }, "isRecoverable": { "type": "boolean" }, "requiresReauthorization": { "type": "boolean" }, "provider": { "type": "string", "const": "outlook" } }, "required": [ "errorMessage", "accountId", "provider" ], "additionalProperties": false } ], "type": "object" }, "User": { "type": "object", "properties": { "id": { "type": "string" }, "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "accessTokenExpiresAt": { "type": "string" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "displayName": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "locale": { "type": "string" }, "profilePhotoURL": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "canceled", "testing", "banned" ] }, "notionUserId": { "type": "string" } }, "required": [ "id", "createdAt", "email", "username", "accounts", "displayName" ], "additionalProperties": false }, "Calendar": { "type": "object", "properties": { "accountId": { "type": "string" }, "accessRole": { "type": "string", "enum": [ "freeBusyReader", "reader", "writer", "owner" ], "description": "Access level the user has over this calendar." }, "defaultReminders": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarReminder" } }, "etag": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "calendar#calendarList", "calendar#calendarListEntry", "calendar#participant", "calendar#teammate", "calendar#timeCollectionView" ] }, "summary": { "type": "string" }, "provider": { "$ref": "#/components/schemas/DataProvider" }, "notificationSettings": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "const": "email" }, "type": { "type": "string", "enum": [ "eventCreation", "eventChange", "eventCancellation", "eventResponse", "agenda" ] } }, "required": [ "method", "type" ], "additionalProperties": false } } }, "required": [ "notifications" ], "additionalProperties": false }, "conferenceProperties": { "type": "object", "properties": { "allowedConferenceSolutionTypes": { "type": "array", "items": { "type": "string", "enum": [ "eventHangout", "eventNamedHangout", "hangoutsMeet", "teamsForBusiness", "addOn" ] } } }, "additionalProperties": false }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "location": { "type": "string" }, "primary": { "type": "boolean" }, "selected": { "type": "boolean" }, "summaryOverride": { "type": [ "string", "null" ] }, "timeZone": { "type": "string" }, "selfAttendee": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "owner": { "type": "object", "properties": { "email": { "type": "string" }, "displayName": { "type": "string" }, "self": { "type": "boolean" } }, "additionalProperties": false }, "backgroundColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "colorId": { "deprecated": true, "type": "string" }, "foregroundColor": { "deprecated": true, "type": "string", "pattern": "^#[0-9A-Fa-f]{6}(?:[0-9A-Fa-f]{2})?$" }, "orderIndex": { "type": "string" }, "pinned": { "type": "boolean" }, "teammate": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false }, "subtitle": { "type": "string" }, "emoji": { "type": "string" }, "iconUrl": { "type": "string" }, "notionViewType": { "type": "string" }, "notionViewIcon": { "type": "string" }, "notionUrl": { "type": "string" }, "notionPath": { "type": "array", "items": { "type": "string" } }, "notionParentId": { "type": "string" }, "notionStatusPropertyId": { "type": [ "string", "null" ] }, "notionCollection": { "type": "object", "properties": { "id": { "type": "string" }, "properties": {}, "propertyFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "property" ], "additionalProperties": false } }, "propertyVisibilityFormat": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "show", "hide", "hide_if_empty", "section" ] }, { "type": "string" } ] } }, "required": [ "property", "visibility" ], "additionalProperties": false } }, "timePropertyId": { "type": "string" }, "statusFilter": { "type": "string", "enum": [ "all", "notDone" ] }, "dateFilter": { "type": "string", "enum": [ "all", "scheduled", "unscheduled" ] }, "availableViews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "collectionId": { "type": "string" }, "iconPath": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id", "type", "name" ], "additionalProperties": false } }, "groupBy": { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ], "additionalProperties": false } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "property", "type", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, "groupByOverride": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "status" }, "groupBy": { "type": "string", "enum": [ "group", "option" ] }, "sort": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "ascending" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "descending" } }, "required": [ "type" ], "additionalProperties": false } ], "type": "object" } }, "required": [ "property", "type", "groupBy", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string", "const": "checkbox" }, "sort": { "type": "object", "properties": { "type": { "type": "string", "const": "manual" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "property", "type", "sort" ], "additionalProperties": false }, { "type": "object", "properties": { "property": { "type": "string" }, "hideEmptyGroups": { "type": "boolean" }, "disableBoardColorColumns": { "type": "boolean" }, "type": { "type": "string" }, "groupBy": {}, "sort": {} }, "required": [ "property", "type" ], "additionalProperties": {} } ] }, { "type": "null" } ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "status" }, "value": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "by_group" }, "group": { "type": "string" } }, "required": [ "type", "group" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "by_option" }, "option": { "type": "string" } }, "required": [ "type", "option" ], "additionalProperties": false } ], "type": "object" }, { "not": {} } ] } }, "required": [ "type", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "checkbox" }, "value": { "type": "boolean" } }, "required": [ "type", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string" }, "value": {} }, "required": [ "type" ], "additionalProperties": {} } ] }, "hidden": { "type": "boolean" }, "emptyHidden": { "type": "boolean" }, "hiddenByDefault": { "type": "boolean" } }, "required": [ "property", "value" ], "additionalProperties": false } }, "filter": {} }, "additionalProperties": false } }, "required": [ "accountId", "accessRole", "defaultReminders", "etag", "id", "kind", "summary", "provider" ], "additionalProperties": false } }, "securitySchemes": { "bearerToken": { "type": "http", "scheme": "Bearer" } } } }