{ "openapi": "3.1.0", "info": { "title": "Reassign REST API", "version": "1.0.0", "summary": "Read and write a Reassign day plan over HTTP.", "description": "The public REST API for Reassign, the 24-hour circular day planner. It exposes the same engine the MCP server uses: read a day, create and move events, place work into free time, reflect on a past day, log moments against trackers, and manage areas, activity types, and the Inbox.\n\nPublic endpoints need a Bearer token, or the signed-in app session cookie, and generally Reassign Pro access. The 7-day free trial includes Reassign Pro. App-only projections instead require the session cookie, as marked on each operation. A token is either a Personal Access Token (`rsk_live_…`) or an OAuth 2.1 access token minted for the `https://reassign.app/api/v1` resource. Reads need the `events:read` or `events:write` scope. Write access includes read access; writes need `events:write`.\n\nA span is `start` + `end`, two local datetimes \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z) in the account's time zone, which a response names once as the top-level `timezone`. The end is after the start; an overnight or multi-day event simply ends on a later day. Dates are ISO \"YYYY-MM-DD\" and instants are ISO 8601 UTC strings. One occurrence of a recurring event has the composite id `seriesId@YYYY-MM-DD`, and a bare series id addresses the whole series; `scope: \"future\"` on an occurrence id also edits every later occurrence.\n\nA path that no route serves, for example a removed route, first applies the same auth check, then answers 404 `not_found` \"No API route has this path.\"; a Chrome extension build before 1.2.0 gets 422 `validation` \"Update the Reassign extension to 1.2.0.\" in its place.", "contact": { "name": "Reassign", "url": "https://reassign.app" }, "termsOfService": "https://reassign.ai/terms", "x-source-commit": "c86570e3c15fcc4a557f5be02dfd07ca3fe2fe74" }, "servers": [ { "url": "https://reassign.app", "description": "This deployment" } ], "security": [ { "bearerAuth": [] }, { "appSession": [] } ], "tags": [ { "name": "Reassign", "description": "The public day-planner API." } ], "paths": { "/api/v1/schedule": { "get": { "operationId": "getSchedule", "summary": "Read a day or a range of days", "description": "The full context for the days from `from` to `to` (equal for one day): events, free slots, load by area and activity type, and the areas, activity types, projects and preferences of the caller. An archived project has `archived: true`: it refuses new links, and a categories update with `archived: false` restores it. Every event and free slot is a `start` + `end` pair of local datetimes in the top-level `timezone`. `now` is the current local datetime. `integrations` is present when a calendar is connected, and `backlogCount` when the Inbox is not empty. With `includeBacklog`, `backlogProjectId` (a project id, or `none`) and `backlogMinPriority` (0 to 4) filter the Inbox items. A free slot on today starts after the current time. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "First day of the range, inclusive.", "example": "2026-08-14", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "description": "Last day of the range, inclusive.", "example": "2026-08-14", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "includeSeries", "in": "query", "required": false, "description": "Also return the recurring masters as `series`.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "includeLookups", "in": "query", "required": false, "description": "Default true. Pass false to leave out `areas`, `activityTypes`, `projects` and `integrations` when you already have them from an earlier read.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "minDuration", "in": "query", "required": false, "description": "Return only the `freeSlots` of at least this many minutes.", "schema": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" } }, { "name": "includeBacklog", "in": "query", "required": false, "description": "Include the Inbox items (the `backlog` array), not just `backlogCount`. Pass true when the user wants to see, schedule, or manage their Inbox.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "backlogQuery", "in": "query", "required": false, "description": "Filter the Inbox blocks by name (fuzzy, case/accent-insensitive), e.g. \"dentist\". Needs includeBacklog: true.", "schema": { "type": "string", "minLength": 1 } }, { "name": "backlogPlannedOn", "in": "query", "required": false, "description": "Filter the Inbox blocks to those planned for this day (a planned day, or a planned window that covers it). Needs includeBacklog: true; composes with backlogQuery.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "backlogProjectId", "in": "query", "required": false, "description": "Filter the Inbox blocks to one project id, or \"none\" for the blocks with no project. Needs includeBacklog: true; composes with the other filters.", "schema": { "type": "string", "minLength": 1 } }, { "name": "backlogMinPriority", "in": "query", "required": false, "description": "Filter the Inbox blocks to a priority of at least this value (0 none, 1 low, 2 medium, 3 high, 4 urgent). Needs includeBacklog: true; composes with the other filters.", "schema": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" } }, { "name": "backlogOffset", "in": "query", "required": false, "description": "Inbox page offset from nextBacklogOffset; keep the same filters. Needs includeBacklog: true.", "schema": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1 }, "now": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "weather": { "type": "string" }, "energy": { "type": "string" }, "days": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "events": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "freeSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "loadByArea": { "type": "array", "items": { "type": "object", "properties": { "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "areaId", "minutes", "eventCount" ], "additionalProperties": false } }, "loadByActivityType": { "type": "array", "items": { "type": "object", "properties": { "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "activityTypeId", "minutes", "eventCount" ], "additionalProperties": false } }, "loadByProject": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "minutes", "eventCount" ], "additionalProperties": false } }, "nonBlockingLoadByArea": { "type": "array", "items": { "type": "object", "properties": { "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "areaId", "minutes", "eventCount" ], "additionalProperties": false } }, "nonBlockingLoadByActivityType": { "type": "array", "items": { "type": "object", "properties": { "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "activityTypeId", "minutes", "eventCount" ], "additionalProperties": false } }, "review": { "type": "object", "properties": { "reviewedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "adherence": { "type": "object", "properties": { "event": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "layer": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unplannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byArea": { "type": "array", "items": { "type": "object", "properties": { "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "adherence": { "type": "number", "minimum": 0, "maximum": 1 }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "areaId", "adherence", "plannedMinutes" ], "additionalProperties": false } }, "byActivityType": { "type": "array", "items": { "type": "object", "properties": { "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "adherence": { "type": "number", "minimum": 0, "maximum": 1 }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "activityTypeId", "adherence", "plannedMinutes" ], "additionalProperties": false } } }, "required": [ "event", "layer", "plannedMinutes", "unplannedMinutes", "byArea", "byActivityType" ], "additionalProperties": false } }, "required": [ "reviewedAt" ], "additionalProperties": false } }, "required": [ "date", "events", "freeSlots", "loadByArea", "loadByActivityType", "loadByProject" ], "additionalProperties": false } }, "loadByProject": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "minutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eventCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "minutes", "eventCount" ], "additionalProperties": false } }, "areas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "activityTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "description": "Present on an archived project: it refuses new links, and an update with archived: false restores it.", "type": "boolean", "const": true } }, "required": [ "id", "name", "areaId" ], "additionalProperties": false } }, "userPreferences": { "type": "object", "properties": { "conflictPolicy": { "type": "string", "const": "propose", "description": "Always `propose`: a write that collides is refused with free slots." } }, "required": [ "conflictPolicy" ], "additionalProperties": false }, "integrations": { "type": "object", "properties": { "aiClassify": { "type": "boolean" }, "aiRules": { "type": "string" }, "aiRuleWarnings": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "missing_taxonomy_reference", "ambiguous_taxonomy_reference" ] }, "field": { "type": "string", "enum": [ "area", "activityType" ] }, "name": { "type": "string" } }, "required": [ "code", "field", "name" ], "additionalProperties": false } }, "defaultCalendarId": { "type": "string", "minLength": 1 }, "sources": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist" ] }, "account": { "type": "string" }, "status": { "type": "string", "enum": [ "connected", "disconnected", "error", "pending", "revoked" ] }, "calendars": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "writable": { "type": "boolean" }, "area": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "automatic" } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "const": "fixed" }, "areaId": { "type": "string", "minLength": 1 } }, "required": [ "mode", "areaId" ], "additionalProperties": false } ] }, "activityType": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "automatic" } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "const": "fixed" }, "activityTypeId": { "type": "string", "minLength": 1 } }, "required": [ "mode", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "const": "none" } }, "required": [ "mode" ], "additionalProperties": false } ] }, "kind": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "automatic" } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "const": "fixed" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] } }, "required": [ "mode", "kind" ], "additionalProperties": false } ] }, "timezone": { "type": "string", "minLength": 1 }, "copyStyle": { "type": "string", "enum": [ "full", "private", "busy" ] }, "busyCopyTitle": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "writable", "area", "activityType", "kind" ], "additionalProperties": false } } }, "required": [ "provider", "status", "calendars" ], "additionalProperties": false } } }, "required": [ "aiClassify", "sources" ], "additionalProperties": false }, "series": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "recurrence": { "type": "string" }, "nextOccurrence": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] }, "overrides": { "type": "object", "properties": { "edited": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deleted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "edited", "deleted" ], "additionalProperties": false }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true } }, "required": [ "start", "end", "id", "name", "recurrence", "nextOccurrence", "overrides", "areaId", "activityTypeId", "kind", "source" ], "additionalProperties": false } }, "backlogCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "backlogMatchedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextBacklogOffset": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "backlog": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } } }, "required": [ "timezone", "now", "days", "userPreferences" ], "additionalProperties": false }, "example": { "timezone": "Europe/Ljubljana", "now": "2026-08-14T10:42", "days": [ { "date": "2026-08-14", "events": [ { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "start": "2026-08-14T09:00", "end": "2026-08-14T10:30", "kind": "blocking", "name": "Team sync", "source": "google", "meeting": { "url": "https://us02web.zoom.us/j/1234567890", "label": "Zoom" }, "location": { "text": "Room 4, 2nd floor", "url": "https://www.google.com/maps/search/?api=1&query=Room%204%2C%202nd%20floor" }, "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "projectId": null, "priority": 0, "calendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "mirrorCalendarIds": [ "a1b2c3d4-5e6f-4071-8293-a4b5c6d7e8f9" ] } ], "freeSlots": [ { "start": "2026-08-14T10:45", "end": "2026-08-15T00:00" } ], "loadByArea": [ { "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "minutes": 90, "eventCount": 1 } ], "loadByActivityType": [ { "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "minutes": 90, "eventCount": 1 } ], "loadByProject": [ { "projectId": null, "minutes": 90, "eventCount": 1 } ] } ], "areas": [ { "id": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "name": "Work", "color": "#3b82f6" } ], "activityTypes": [ { "id": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "name": "Focus", "pattern": "solid" } ], "projects": [], "userPreferences": { "conflictPolicy": "propose" }, "integrations": { "aiClassify": true, "defaultCalendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "sources": [ { "provider": "google", "account": "user@example.com", "status": "connected", "calendars": [ { "id": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "name": "Work", "writable": true, "area": { "mode": "automatic" }, "activityType": { "mode": "automatic" }, "kind": { "mode": "automatic" } }, { "id": "a1b2c3d4-5e6f-4071-8293-a4b5c6d7e8f9", "name": "Team", "writable": true, "area": { "mode": "automatic" }, "activityType": { "mode": "automatic" }, "kind": { "mode": "automatic" } } ] } ] }, "backlogCount": 1 } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`from`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/schedule/plan": { "post": { "operationId": "planSchedule", "summary": "Book work into free time", "description": "Place work into free time without computing slots yourself. Send 1 to 20 `requests`. Each request has a `name` (1 to 200 characters), an integer `durationMinutes`, and either an exact `start` or an `earliest` + `latest` window (local datetimes, at most 24 hours apart). The call is atomic by default: when a row fails, nothing is written and the other rows are `skipped`. With `partial: true`, the rows that succeed are written and the failed rows are errors. A request row that is not valid, for example one with both `start` and a window, has `status: \"error\"` with the code `validation`. Each row parses alone, so a row error names the field by its path inside the row, for example \"`name`: Too small: expected string to have >=1 characters\". Every request that succeeds books at once, and the row `result` has the `event`: an exact `start` books there when it is free, and a window books its top-ranked free slot. `autoCommitBest` is deprecated and has no effect. A taken exact `start` is a `conflict` row with `conflicts` and `nearestSlots`; send a slot's `start` as a new request to take it. A window with no free slot is a `conflict` row. `projectId` links a live project: with no `areaId`, the event takes the area of the project, and an archived project is `not_found`. `priority` is 0 (none, the default) to 4 (urgent). `calendarId` and `mirrorCalendarIds` choose the calendars, and `mirrorStyles` sets how much each copy shows, as on an event create. Today, a start must be more than 5 minutes after now. A `requestId` makes a retry within 60 seconds replay the first result; a request without one is always new. A replayed row is `ok` with `replayed: true`, also when another row fails. Requires the `events:write` scope, which also includes read access. Returns `results`, one row per op with its 0-based `index` and a `status` of `ok`, `error`, or `skipped`. An `ok` row has the `result`, an `error` row has `error: { code, message }` (plus `conflicts` and `nearestSlots` on a conflict), and a `skipped` row has the `reason`. When something was written, the body has one `undoToken` and its `expiresAt`. When no op applied, the status is the code that the failed ops share (400 with `batch_rejected` when they differ) and the body adds the `error` envelope.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Event title, e.g. \"Deep work\", \"Gym\"." }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 1440, "description": "How long, in whole minutes, e.g. 90." }, "areaId": { "description": "Area id to attach (from the schedule read's `areas`); null or omitted leaves it unset.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "Activity-type id to attach (from the schedule read's `activityTypes`); null or omitted leaves it unset.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the event takes the area of the project. null or omitted leaves it unset.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit for 0.", "type": "integer", "minimum": 0, "maximum": 4 }, "recurrence": { "description": "Repeat rule as an RRULE, e.g. \"FREQ=WEEKLY;BYDAY=MO\"; omit for a one-off.", "type": "string" }, "kind": { "description": "\"blocking\" (default) cannot overlap others; \"non_blocking\" is an overlay (e.g. a fasting band or an away/OOO marker) that may overlap and never conflicts; \"reference\" is something the user wants to SEE but is not doing — non-blocking, and don't move, delete, or schedule work into it unless asked. Note a non-blocking request still SEARCHES for a free slot like any other; it simply does not occupy one once placed.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "notes": { "type": "string", "maxLength": 2000 }, "sourceUrl": { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, "calendarId": { "description": "The home calendar: a calendar id (from the calendars list or the schedule's `integrations`). Omit it to use the account's default calendar if one is set, else the event stays on the dial only. null keeps the event on the dial only. A calendar id requires Reassign Pro; whole-series only.", "type": [ "string", "null" ] }, "mirrorCalendarIds": { "description": "The one-way copy calendars, as calendar ids. It must not contain the home `calendarId`. On update it REPLACES the set; [] clears it. An id already on the event may stay even if its calendar is read-only now; only an added id is checked. Adding an id requires Reassign Pro; whole-series only.", "type": "array", "items": { "type": "string" } }, "mirrorStyles": { "description": "How much each copy shows, per copy calendar id: 'full' (default) copies the title and notes; 'private' keeps them but marks the copy private; 'busy' is a shield: a private copy with a neutral title (the calendar's busy title, else \"Busy\"), no notes, and no reminders. Each key must be in the event's mirrorCalendarIds. A calendar left out uses that calendar's default copy style. On update it REPLACES the map; {} clears it. Needs Reassign Pro; whole-series only.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "requestId": { "description": "Idempotency key; reuse on retry to avoid double-booking. Only this key replays: a request without it is always booked as new.", "type": "string" }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Exact local start \"YYYY-MM-DDTHH:MM\"; place there. A taken start is a `conflict` error with `nearestSlots`." } }, "required": [ "name", "durationMinutes", "start" ], "additionalProperties": false, "description": "An exact request: book at `start`." }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Event title, e.g. \"Deep work\", \"Gym\"." }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 1440, "description": "How long, in whole minutes, e.g. 90." }, "areaId": { "description": "Area id to attach (from the schedule read's `areas`); null or omitted leaves it unset.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "Activity-type id to attach (from the schedule read's `activityTypes`); null or omitted leaves it unset.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the event takes the area of the project. null or omitted leaves it unset.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit for 0.", "type": "integer", "minimum": 0, "maximum": 4 }, "recurrence": { "description": "Repeat rule as an RRULE, e.g. \"FREQ=WEEKLY;BYDAY=MO\"; omit for a one-off.", "type": "string" }, "kind": { "description": "\"blocking\" (default) cannot overlap others; \"non_blocking\" is an overlay (e.g. a fasting band or an away/OOO marker) that may overlap and never conflicts; \"reference\" is something the user wants to SEE but is not doing — non-blocking, and don't move, delete, or schedule work into it unless asked. Note a non-blocking request still SEARCHES for a free slot like any other; it simply does not occupy one once placed.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "notes": { "type": "string", "maxLength": 2000 }, "sourceUrl": { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, "calendarId": { "description": "The home calendar: a calendar id (from the calendars list or the schedule's `integrations`). Omit it to use the account's default calendar if one is set, else the event stays on the dial only. null keeps the event on the dial only. A calendar id requires Reassign Pro; whole-series only.", "type": [ "string", "null" ] }, "mirrorCalendarIds": { "description": "The one-way copy calendars, as calendar ids. It must not contain the home `calendarId`. On update it REPLACES the set; [] clears it. An id already on the event may stay even if its calendar is read-only now; only an added id is checked. Adding an id requires Reassign Pro; whole-series only.", "type": "array", "items": { "type": "string" } }, "mirrorStyles": { "description": "How much each copy shows, per copy calendar id: 'full' (default) copies the title and notes; 'private' keeps them but marks the copy private; 'busy' is a shield: a private copy with a neutral title (the calendar's busy title, else \"Busy\"), no notes, and no reminders. Each key must be in the event's mirrorCalendarIds. A calendar left out uses that calendar's default copy style. On update it REPLACES the map; {} clears it. Needs Reassign Pro; whole-series only.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "requestId": { "description": "Idempotency key; reuse on retry to avoid double-booking. Only this key replays: a request without it is always booked as new.", "type": "string" }, "earliest": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Start of the local \"YYYY-MM-DDTHH:MM\" window to search." }, "latest": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "End of the search window: after `earliest` and at most 24 hours later; it may be on the next day." }, "autoCommitBest": { "description": "Deprecated: a window always books its top-ranked free slot. Accepted so that older clients still work.", "type": "boolean", "const": true } }, "required": [ "name", "durationMinutes", "earliest", "latest" ], "additionalProperties": false, "description": "A window request: search from `earliest` to `latest`, at most 24 hours." } ] } }, "partial": { "description": "Best-effort mode: apply the rows that succeed and report the rest as errors, instead of the default all-or-nothing.", "type": "boolean" } }, "required": [ "requests" ], "additionalProperties": false }, "example": { "requests": [ { "name": "Write the launch post", "durationMinutes": 90, "earliest": "2026-08-14T09:00", "latest": "2026-08-14T18:00", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "projectId": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f60718", "priority": 3, "requestId": "launch-post-0814" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1 }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "results" ], "additionalProperties": false }, "example": { "timezone": "Europe/Ljubljana", "undoToken": "00000000-0000-4000-8000-000000000001", "expiresAt": "2026-08-13T09:12:00.000Z", "results": [ { "index": 0, "status": "ok", "result": { "event": { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "start": "2026-08-14T11:00", "end": "2026-08-14T12:30", "kind": "blocking", "name": "Write the launch post", "source": "reassign", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": null, "projectId": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f60718", "priority": 3 } } } ] } } } }, "400": { "description": "Every op failed, and the failed ops have different codes. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed. The code is `batch_rejected`.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\" When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "Every request failed with the code `not_found`. The `areaId` or `activityTypeId` of each request names an area or an activity type that does not exist or that the caller cannot see, or its `projectId` names no live project of the caller. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "409": { "description": "An op conflicts with the current state. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "validation", "message": "`requests`: Invalid input: expected array, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "replayed": { "type": "boolean", "const": true } }, "required": [ "event" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/actions/undo": { "post": { "operationId": "undo", "summary": "Reverse a recent write", "description": "Reverse 1 to 20 prior writes with the `undoToken` values that they returned, before their `expiresAt` (30 minutes). Every row `result` has the same counts of the rows that the undo changed: `reverted` (the total), `restored`, `removed` and `voided`, each 0 when nothing of that kind changed. When a row that the write touched changed again later, or a token has no change stamps, the row fails with `stale` and the undo changes nothing. An undo writes no new `undoToken`. Requires the `events:write` scope, which also includes read access. Returns `results`, one row per op with its 0-based `index` and a `status` of `ok` or `error`. An `ok` row has the `result` and an `error` row has `error: { code, message }`. When no op applied, the status is the code that the failed ops share (400 with `batch_rejected` when they differ) and the body adds the `error` envelope.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tokens": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string" }, "description": "The `undoToken` from an earlier write’s successfully recorded undo receipt." } }, "required": [ "tokens" ], "additionalProperties": false }, "example": { "tokens": [ "00000000-0000-4000-8000-000000000001" ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "results" ], "additionalProperties": false }, "example": { "results": [ { "index": 0, "status": "ok", "result": { "reverted": 1, "restored": 1, "removed": 0, "voided": 0 } } ] } } } }, "400": { "description": "Every op failed, and the failed ops have different codes. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed. The code is `batch_rejected`.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\" When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "An op names an item that does not exist. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "409": { "description": "The request conflicts with the current state: `conflict` \"A calendar sync is sending this change now. Try the undo again in a moment.\" or `stale` \"A row that this write changed has a newer change. The undo stops, so that it does not overwrite it. Nothing changed.\" or `stale` \"This undo token is from an older version and cannot be checked. Undo is not available for it.\" When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "conflict", "message": "A calendar sync is sending this change now. Try the undo again in a moment." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "validation", "message": "`tokens`: Invalid input: expected array, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "type": "object", "properties": { "reverted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restored": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voided": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrenceRestored": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "reverted", "restored", "removed", "voided" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/calendars": { "get": { "operationId": "listCalendars", "summary": "List the connected calendars", "description": "The connected calendars of the caller, flat, in the picker order. Each `id` is the value that an event's `calendarId` and `mirrorCalendarIds` take. Only a `writable: true` calendar is a valid target. The list also has the calendars that are not writable, so that a client can name the origin of a read-only event. `defaultCalendarId` is the default home calendar of the account. Requires `events:read` or `events:write` (includes read access).", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "calendars": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "provider": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist" ] }, "kind": { "type": "string", "enum": [ "calendar", "tasks" ] }, "account": { "type": "string" }, "color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, { "type": "null" } ] }, "writable": { "type": "boolean" } }, "required": [ "id", "name", "provider", "kind", "account", "color", "writable" ], "additionalProperties": false } } }, "required": [ "defaultCalendarId", "calendars" ], "additionalProperties": false }, "example": { "defaultCalendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "calendars": [ { "id": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "name": "Work", "provider": "google", "kind": "calendar", "account": "user@example.com", "color": "#4285f4", "writable": true }, { "id": "a1b2c3d4-5e6f-4071-8293-a4b5c6d7e8f9", "name": "Holidays", "provider": "google", "kind": "calendar", "account": "user@example.com", "color": "#0b8043", "writable": false } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/events": { "get": { "operationId": "pollEvents", "summary": "Poll for changed events", "description": "The stored event rows that changed after `cursor`, oldest first. Omit `cursor` on the first poll. Send the returned `cursor` as the next `cursor`; it is opaque text. The cursor holds the exact position of the last row, so a page boundary never skips or repeats a row. `hasMore` is true when more rows wait. Recurrence is not expanded and deleted rows are not in the page. To read a day, use `GET /api/v1/schedule`. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "cursor", "in": "query", "required": false, "description": "The opaque `cursor` of the last poll. The rows that changed after it return. Omit it on the first poll.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "The page size, 1 to 500 (default 100).", "schema": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "recurrence": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "updatedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "required": [ "start", "end", "id", "name", "areaId", "activityTypeId", "updatedAt" ], "additionalProperties": false } }, "cursor": { "type": "string", "minLength": 1 }, "hasMore": { "type": "boolean" }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "events", "cursor", "hasMore", "timezone" ], "additionalProperties": false }, "example": { "events": [ { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "name": "Team sync", "start": "2026-08-13T09:00", "end": "2026-08-13T10:30", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "updatedAt": "2026-08-13T08:40:00.000Z" } ], "cursor": "MjAyNi0wOC0xM1QwODo0MDowMC4xMjM0NTZafGI3ZjFjMmEwLTFkMmUtNGYzYS05YjhjLTVkNmU3ZjgwMTIzNA", "hasMore": false, "timezone": "Europe/Ljubljana" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Repeated query parameter `cursor`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "post": { "operationId": "writeEvents", "summary": "Create, change, or delete events", "description": "The one event write. Send 1 to 50 `ops`; each op names its verb: `create`, `update`, `shift`, `reflect`, `checklist`, `delete`, or `clear`. A span is `start` + `end`, two local datetimes \"YYYY-MM-DDTHH:MM\"; the end is after the start, also on a later day. `update` with `start` or `end` moves the event, also to another day. A bare series id addresses the whole series, `seriesId@YYYY-MM-DD` one occurrence, and `scope: \"future\"` on an occurrence id that occurrence and the later ones. `calendarId` is the home calendar (on `create`, omit it for the account default calendar if one is set, else the dial only; on `update`, omit it to keep the current home; `null` for the dial only) and `mirrorCalendarIds` the one-way copies. `areaId` and `activityTypeId` take an id or `null`: on `update`, `null` clears the link and an omitted key keeps it; on `create`, `null` is the same as omitted. Calendar sync needs Reassign Pro. The 7-day free trial includes it. The batch is atomic by default; with `partial: true` it applies the ops that it can. A create returns `{ created }`, an edit `{ updated }`, a delete `{ deletedIds }`, and a clear `{ breakdown, items, truncated }`. A create, or an update that gives a series a new rule, adds `firstOccurrence` when the first real occurrence is not on the start day. A `scope: \"future\"` delete also returns the shortened series as `updated`. An edit of one occurrence returns that occurrence as `seriesId@YYYY-MM-DD`, with the original date, also when the edit moved it to another day. Requires the `events:write` scope, which also includes read access. Returns `results`, one row per op with its 0-based `index` and a `status` of `ok`, `error`, or `skipped`. An `ok` row has the `result`, an `error` row has `error: { code, message }` (plus `conflicts` and `nearestSlots` on a conflict), and a `skipped` row has the `reason`. When something was written, the body has one `undoToken` and its `expiresAt`. When no op applied, the status is the code that the failed ops share (400 with `batch_rejected` when they differ) and the body adds the `error` envelope.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ops": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "create" }, "id": { "description": "Optional client-minted UUID event id, so the caller can read the new event back by a known id. Omit it and the server mints one.", "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)$" }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day. Its day is the event's day." }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day." }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "sourceUrl": { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, "checklist": { "description": "Starter microtasks written to the new event's checklist.", "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Keep an existing item's id; omit for a new item.", "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1, "maxLength": 200 }, "done": { "description": "true ticks the item off, false clears it; omit to keep the current state (a new item starts not done).", "type": "boolean" } }, "required": [ "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "areaId": { "description": "The area id (from the schedule read). null or omitted leaves it unset.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "The activity type id (from the schedule read). null or omitted leaves it unset.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the event takes the area of the project. null or omitted leaves it unset.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit for 0.", "type": "integer", "minimum": 0, "maximum": 4 }, "recurrence": { "description": "How the event repeats, as an RRULE (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE,FR\"). Omit for a one-off.", "type": "string" }, "recurrenceEnd": { "description": "Inclusive last day of the repeat, \"YYYY-MM-DD\". Needs `recurrence`.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "description": "\"blocking\" (default) cannot overlap others; \"non_blocking\" is an overlay (e.g. a fasting band or an away/OOO marker) that may overlap and never conflicts; \"reference\" is something the user wants to SEE but isn't doing (e.g. a kid's training they drop off at) — non-blocking, and don't move, delete, or schedule work into it unless asked.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "focusIntervals": { "description": "Split a BLOCKING block into a repeating focus/break rhythm (pomodoro), e.g. {focusMin:25,breakMin:5}. The breaks fall BETWEEN the focus intervals and the block always ends on a focus. A non_blocking or reference event rejects it.", "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "calendarId": { "description": "The home calendar: a calendar id (from the calendars list or the schedule's `integrations`). Omit it to use the account's default calendar if one is set, else the event stays on the dial only. null keeps the event on the dial only. A calendar id requires Reassign Pro; whole-series only.", "type": [ "string", "null" ] }, "mirrorCalendarIds": { "description": "The one-way copy calendars, as calendar ids. It must not contain the home `calendarId`. On update it REPLACES the set; [] clears it. An id already on the event may stay even if its calendar is read-only now; only an added id is checked. Adding an id requires Reassign Pro; whole-series only.", "type": "array", "items": { "type": "string" } }, "mirrorStyles": { "description": "How much each copy shows, per copy calendar id: 'full' (default) copies the title and notes; 'private' keeps them but marks the copy private; 'busy' is a shield: a private copy with a neutral title (the calendar's busy title, else \"Busy\"), no notes, and no reminders. Each key must be in the event's mirrorCalendarIds. A calendar left out uses that calendar's default copy style. On update it REPLACES the map; {} clears it. Needs Reassign Pro; whole-series only.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } } }, "required": [ "op", "start", "end", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string", "minLength": 1, "description": "The event id from a read. A bare series id addresses the whole series; `seriesId@YYYY-MM-DD` addresses one occurrence by its ORIGINAL date (the read's `originalDate`), also after the occurrence moved." }, "scope": { "type": "string", "const": "future", "description": "Only with a `seriesId@YYYY-MM-DD` id: \"future\" edits that occurrence and every later one. Omit it to edit only that occurrence; a bare series id edits the whole series." }, "start": { "description": "Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day. A new start moves the event, also to another day (on an occurrence id, that occurrence only). A lone start keeps the duration.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "description": "Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day. A lone end keeps the start.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "sourceUrl": { "description": "Replace where this event was captured from (http(s)); null clears it. Whole-series only.", "anyOf": [ { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, { "type": "null" } ] }, "areaId": { "description": "The area id (from the schedule read). null clears the link; omit to keep it.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "The activity type id (from the schedule read). null clears the link; omit to keep it.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the event takes the area of the project. null clears the project and keeps the area; omit to keep it.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit to keep it.", "type": "integer", "minimum": 0, "maximum": 4 }, "recurrence": { "description": "A new RRULE for the series; null stops the repeat.", "type": [ "string", "null" ] }, "recurrenceEnd": { "description": "Inclusive last day of the repeat, \"YYYY-MM-DD\". Needs `recurrence`.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "description": "Change the event kind: \"blocking\", \"non_blocking\", or \"reference\" (see-only — non-blocking, don't schedule work into it).", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "calendarId": { "description": "Re-home the event: a calendar id (from the calendars list or the schedule's `integrations`) moves it to that calendar; null unlinks it and deletes its mirror copies (keeps the dial block). An unlink may carry start, end, name, notes, areaId, activityTypeId and kind, applied first in the same write. Omit to keep the current home. A calendar id requires Reassign Pro; whole-series only.", "type": [ "string", "null" ] }, "mirrorCalendarIds": { "description": "The one-way copy calendars, as calendar ids. It must not contain the home `calendarId`. On update it REPLACES the set; [] clears it. An id already on the event may stay even if its calendar is read-only now; only an added id is checked. Adding an id requires Reassign Pro; whole-series only.", "type": "array", "items": { "type": "string" } }, "mirrorStyles": { "description": "How much each copy shows, per copy calendar id: 'full' (default) copies the title and notes; 'private' keeps them but marks the copy private; 'busy' is a shield: a private copy with a neutral title (the calendar's busy title, else \"Busy\"), no notes, and no reminders. Each key must be in the event's mirrorCalendarIds. A calendar left out uses that calendar's default copy style. On update it REPLACES the map; {} clears it. Needs Reassign Pro; whole-series only.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "focusIntervals": { "description": "Split a BLOCKING block into a repeating focus/break rhythm (pomodoro), e.g. {focusMin:25,breakMin:5}. The breaks fall BETWEEN the focus intervals and the block always ends on a focus. A non_blocking or reference event rejects it. Pass null to remove an existing rhythm.", "anyOf": [ { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "shift" }, "id": { "type": "string", "minLength": 1, "description": "The event id from a read. A bare series id addresses the whole series; `seriesId@YYYY-MM-DD` addresses one occurrence by its ORIGINAL date (the read's `originalDate`), also after the occurrence moved." }, "byMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Minutes to shift by; negative is earlier." }, "scope": { "type": "string", "const": "future", "description": "Only with a `seriesId@YYYY-MM-DD` id: \"future\" edits that occurrence and every later one. Omit it to edit only that occurrence; a bare series id edits the whole series." } }, "required": [ "op", "id", "byMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "reflect" }, "id": { "type": "string", "description": "The event id, echoed verbatim from a schedule or search read. To mark one occurrence of a recurring event, pass the `seriesId@YYYY-MM-DD` id the read returned for that day — don't fabricate the @date yourself." }, "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ], "description": "How a past planned event actually went. \"kept\" = happened as planned; \"skipped\" = didn't happen; \"changed\" = happened but differently (pass actualStart + actualEnd to record the real time); \"added\" = unplanned but happened (its actualStart + actualEnd become the event's time). Marking only records the reflection — it never renames or re-times the plan." }, "actualStart": { "description": "When it actually started. Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day. Send it with actualEnd, only for \"changed\" or \"added\".", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "description": "When it actually ended. Local datetime \"YYYY-MM-DDTHH:MM\" (no seconds, offset or Z). The end must be after the start; an overnight or multi-day event just ends on a later day. Send it with actualStart, only for \"changed\" or \"added\".", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "op", "id", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist" }, "id": { "type": "string", "description": "The event id, echoed verbatim from a schedule or search read. A bare series id edits the template of the whole series; the `seriesId@YYYY-MM-DD` id edits or ticks off that one occurrence." }, "items": { "description": "REPLACE the whole checklist with these microtasks, in order — add, rename, remove, and reorder are all expressed as the resulting list. Read the current items first, then send the full desired list. Pass [] to clear the checklist. A checkoff on a removed item is dropped automatically.", "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Keep an existing item's id; omit for a new item.", "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1, "maxLength": 200 }, "done": { "description": "true ticks the item off, false clears it; omit to keep the current state (a new item starts not done).", "type": "boolean" } }, "required": [ "text" ], "additionalProperties": false } }, "check": { "description": "Item ids to mark DONE for the occurrence. On a recurring event this ticks off that occurrence only.", "maxItems": 100, "type": "array", "items": { "type": "string" } }, "uncheck": { "description": "Item ids to mark NOT-done for the occurrence.", "maxItems": 100, "type": "array", "items": { "type": "string" } } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string", "minLength": 1, "description": "The event id from a read. A bare series id addresses the whole series; `seriesId@YYYY-MM-DD` addresses one occurrence by its ORIGINAL date (the read's `originalDate`), also after the occurrence moved." }, "scope": { "type": "string", "const": "future", "description": "Only with a `seriesId@YYYY-MM-DD` id: \"future\" edits that occurrence and every later one. Omit it to edit only that occurrence; a bare series id edits the whole series." } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "clear" }, "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "First day to clear, ISO \"YYYY-MM-DD\"." }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Last day to clear (inclusive), ISO \"YYYY-MM-DD\". Equal to `from` for one day." } }, "required": [ "op", "from", "to" ], "additionalProperties": false } ] } }, "partial": { "description": "Apply the ops that succeed instead of all or nothing.", "type": "boolean" } }, "required": [ "ops" ], "additionalProperties": false }, "example": { "ops": [ { "op": "create", "name": "Deep work", "start": "2026-08-14T09:00", "end": "2026-08-14T10:30", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "notes": "Draft the launch post.", "calendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061" }, { "op": "update", "id": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293@2026-08-15", "start": "2026-08-15T16:00" }, { "op": "delete", "id": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293@2026-08-16" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1 }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "results" ], "additionalProperties": false }, "example": { "timezone": "Europe/Ljubljana", "undoToken": "00000000-0000-4000-8000-000000000001", "expiresAt": "2026-08-13T09:12:00.000Z", "results": [ { "index": 0, "status": "ok", "result": { "created": { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "start": "2026-08-14T09:00", "end": "2026-08-14T10:30", "kind": "blocking", "name": "Deep work", "notes": "Draft the launch post.", "source": "reassign", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "projectId": null, "priority": 0, "calendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061" } } }, { "index": 1, "status": "ok", "result": { "updated": { "id": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293@2026-08-15", "seriesId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293", "originalDate": "2026-08-15", "start": "2026-08-15T16:00", "end": "2026-08-15T17:30", "kind": "blocking", "name": "Deep work", "recurrence": "FREQ=DAILY", "source": "reassign", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "projectId": null, "priority": 0 } } }, { "index": 2, "status": "ok", "result": { "deletedIds": [ "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293@2026-08-16" ] } } ] } } } }, "400": { "description": "Every op failed, and the failed ops have different codes. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed. The code is `batch_rejected`.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "batch_rejected", "message": "No op was applied; each failed op is in `results`." }, "timezone": "Europe/Ljubljana", "results": [ { "index": 0, "status": "error", "error": { "code": "conflict", "message": "The time overlaps an existing event.", "conflicts": [ { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "name": "Team sync", "start": "2026-08-13T09:00", "end": "2026-08-13T10:30" } ], "nearestSlots": [ { "start": "2026-08-13T11:00", "end": "2026-08-13T12:00", "score": 0.7333, "reason": "close to your requested time" } ] } }, { "index": 1, "status": "error", "error": { "code": "not_found", "message": "Event \"00000000-0000-4000-8000-00000000dead\" not found." } }, { "index": 2, "status": "skipped", "reason": "Not applied — another op in this batch failed; fix the errors and resend." } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\" A rejected batch also answers 403 when every failed op has the same code: `read_only` (the event or the target calendar is not writable, or the op changes the kind of an all-day calendar event) or `permission` (a calendar sync needs Reassign Pro). When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "An op names an item that does not exist. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "409": { "description": "The request conflicts with the current state: `conflict` \"The time overlaps an existing event.\" or `conflict` \"The time overlaps an earlier op in this batch.\" or `conflict` \"An event with this ID already exists.\" When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "conflict", "message": "The time overlaps an existing event." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "validation", "message": "`ops`: Invalid input: expected array, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "updated" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "updated": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "breakdown": { "type": "object", "properties": { "oneOff": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recurringOccurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "override": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "oneOff", "recurringOccurrence", "override" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "name": { "type": "string" } }, "required": [ "date", "name" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "breakdown", "items", "truncated" ], "additionalProperties": false } ] } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/events/{id}": { "get": { "operationId": "getEvent", "summary": "Read one event", "description": "One event by id, and the `timezone` of its span. An occurrence of a recurring event has the id `seriesId@YYYY-MM-DD` and resolves to its own day. A one-off id resolves to the day of its row. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The event id, or `seriesId@YYYY-MM-DD` for one occurrence.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "event", "timezone" ], "additionalProperties": false }, "example": { "event": { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "start": "2026-08-13T09:00", "end": "2026-08-13T10:30", "kind": "blocking", "name": "Team sync", "source": "google", "meeting": { "url": "https://us02web.zoom.us/j/1234567890", "label": "Zoom" }, "location": { "text": "Room 4, 2nd floor", "url": "https://www.google.com/maps/search/?api=1&query=Room%204%2C%202nd%20floor" }, "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "projectId": null, "priority": 0, "calendarId": "8a1f0c2e-3b4d-4e5f-9a0b-1c2d3e4f5061", "mirrorCalendarIds": [ "a1b2c3d4-5e6f-4071-8293-a4b5c6d7e8f9" ] }, "timezone": "Europe/Ljubljana" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "Event not found." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/categories": { "get": { "operationId": "listCategories", "summary": "List areas, activity types and projects", "description": "The areas (each with a colour) and activity types (each with a pattern) of the caller, with the shared global rows. `overridesId` names the global row that an owned row replaces. `projects` lists the projects of the caller, archived ones too; each has a parent `areaId` (or `null`) and takes its colour from that area. Requires `events:read` or `events:write` (includes read access).", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "areas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isGlobal": { "type": "boolean" }, "overridesId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "order", "isGlobal", "overridesId", "color" ], "additionalProperties": false } }, "activityTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isGlobal": { "type": "boolean" }, "overridesId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "order", "isGlobal", "overridesId", "pattern" ], "additionalProperties": false } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "order": { "type": "number" }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The task list that a new Inbox item of the project is created in; null is off." } }, "required": [ "id", "name", "areaId", "order", "archived", "publishCalendarId" ], "additionalProperties": false } } }, "required": [ "areas", "activityTypes", "projects" ], "additionalProperties": false }, "example": { "areas": [ { "id": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "name": "Work", "color": "#3b82f6", "order": 0, "isGlobal": false, "overridesId": null } ], "activityTypes": [ { "id": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "name": "Focus", "pattern": "solid", "order": 0, "isGlobal": false, "overridesId": null } ], "projects": [ { "id": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f60718", "name": "Launch", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "order": 0, "archived": false, "publishCalendarId": null } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "post": { "operationId": "manageCategories", "summary": "Create, update, or delete categories", "description": "Send `areas`, `activityTypes` and `projects`, each a list of at most 50 ops. A project op is `create` (`name`, `areaId`), `update` (`id`, and a `name`, an `areaId`, an `order`, or `archived`), `delete` (`id`; the linked items keep no project; a project that a task list or a Linear project feeds fails with `conflict`, so link the list to another project first, or archive it), or `split` (`id` and `linkId`: a task list or Linear project that feeds the project moves to a new project of its own, \"{name} ({Provider})\" in the same area, with \" 2\" when the name is taken; its Inbox items move with it, and a later sync keeps it there; the result is `{ split }`, and the undo links it back and removes the new project). Two live projects of the caller cannot have the same name, in any area (`conflict`, \"A project named Launch exists in Work.\"). The response has a `projects` list only when the request sent project ops. Each op names its verb: `create` (`name`, 1 to 60 characters), `update` (`id`, and a `name`, a colour or pattern, or an `order`), or `delete` (`id`, and `reassignTo`: another category id to move the linked items onto, or `null` to clear their link). A delete without `reassignTo` of a category that live events, Inbox items, trackers or calendar defaults use fails with `validation`; its row carries `usage` (the counts, for a shared global row and its owned copy together) and `reassignTargets` (the `{ id, name }` of each category that can take them). A delete of a shared global row hides it for the caller only. A row result is `{ created }`, `{ updated }`, `{ deletedIds }`, or `{ split }`. An update of a shared global row makes an owned copy, so its result has a new `id` and `forkedFrom`. The batch is atomic by default; with `partial: true` it applies the ops that it can. An op that is not valid gets a row with `status: \"error\"` and the code `validation`, so the body shows which op is bad. A `create` or a rename to a name that another visible category of the same kind has (case, accents and spaces ignored) gets the code `conflict` (409 when every failed op has it). When an op of an atomic batch fails, nothing is written and every other row is `skipped`. Requires the `events:write` scope, which also includes read access. Returns `areas`, `activityTypes` and `projects`, one row per op with its 0-based `index` in its list and a `status` of `ok`, `error`, or `skipped`. An `ok` row has the `result`, an `error` row has `error: { code, message }`, and a `skipped` row has the `reason`. When something was written, the body has one `undoToken` and its `expiresAt`. When no op applied, the status is the code that the failed ops share (400 with `batch_rejected` when they differ) and the body adds the `error` envelope.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "areas": { "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "create" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "color": { "description": "Lowercase \"#rrggbb\"; omit to auto-pick.", "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "op", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "color": { "description": "Lowercase \"#rrggbb\"; omit to auto-pick.", "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string" }, "reassignTo": { "description": "Another area's id to move the linked items onto, or null to clear their link. Required when items use it.", "type": [ "string", "null" ] } }, "required": [ "op", "id" ], "additionalProperties": false } ] } }, "activityTypes": { "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "create" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "pattern": { "description": "A fill pattern; omit to auto-pick.", "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "op", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "pattern": { "description": "A fill pattern; omit to auto-pick.", "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string" }, "reassignTo": { "description": "Another activity type's id to move the linked items onto, or null to clear their link. Required when items use it.", "type": [ "string", "null" ] } }, "required": [ "op", "id" ], "additionalProperties": false } ] } }, "projects": { "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "create" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "The project name; unique among all live projects of the user, in any area." }, "areaId": { "description": "The parent area id, or null for no area. When a write moves an Inbox item to the project and sets no area, the item takes this area.", "type": [ "string", "null" ] } }, "required": [ "op", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "The project name; unique among all live projects of the user, in any area." }, "areaId": { "description": "The parent area id, or null for no area. When a write moves an Inbox item to the project and sets no area, the item takes this area.", "type": [ "string", "null" ] }, "publishCalendarId": { "description": "The task list that a new Inbox item of this project is created in, unless the item names its own list. null turns it off.", "type": [ "string", "null" ] }, "order": { "description": "The sort position.", "type": "number" }, "archived": { "description": "true archives the project: it leaves the lookups and takes no new links, but its links stay. false restores it.", "type": "boolean" } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string", "description": "The project to delete; its items and events keep their area and lose the project link." } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "split" }, "id": { "type": "string", "description": "The shared project to split a link from." }, "linkId": { "type": "string", "description": "The task list (`source_calendars` id) or Linear project (`source_projects` id) that feeds `id` and moves to a new project of its own, \"{name} ({Provider})\"." } }, "required": [ "op", "id", "linkId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "relink" }, "id": { "type": "string", "description": "The live project that the Linear project feeds next." }, "linkId": { "type": "string", "description": "The Linear project (`source_projects` id) to point at `id`. Its Inbox items move along. A task list changes its project in its list settings." } }, "required": [ "op", "id", "linkId" ], "additionalProperties": false } ] } }, "partial": { "description": "Best-effort mode instead of the default all-or-nothing.", "type": "boolean" } }, "additionalProperties": false }, "example": { "areas": [ { "op": "create", "name": "Health", "color": "#22c55e" } ], "activityTypes": [ { "op": "update", "id": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "name": "Deep focus" } ], "projects": [ { "op": "split", "id": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f60718", "linkId": "a4b5c6d7-e8f9-4a01-b2c3-d4e5f6071829" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "areas", "activityTypes" ], "additionalProperties": false }, "example": { "undoToken": "00000000-0000-4000-8000-000000000001", "expiresAt": "2026-08-13T09:12:00.000Z", "areas": [ { "index": 0, "status": "ok", "result": { "created": { "id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c", "name": "Health", "color": "#22c55e" } } } ], "activityTypes": [ { "index": 0, "status": "ok", "result": { "updated": { "id": "5e6f7081-92a3-4b4c-8d5e-6f708192a3b4", "name": "Deep focus", "pattern": "solid" } } } ], "projects": [ { "index": 0, "status": "ok", "result": { "split": { "id": "b5c6d7e8-f9a0-4b12-83d4-e5f60718293a", "name": "Launch (Todoist)", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "fromId": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f60718", "linkId": "a4b5c6d7-e8f9-4a01-b2c3-d4e5f6071829", "movedItems": 3 } } } ] } } } }, "400": { "description": "Every op failed, and the failed ops have different codes. When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed. The code is `batch_rejected`.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\" When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "An op names an item that does not exist. When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] } } } }, "409": { "description": "The request conflicts with the current state: `conflict` \"A project named Launch exists in Work.\" or `conflict` \"Link the task list to a different project first.\" When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] }, "example": { "error": { "code": "conflict", "message": "A project named Launch exists in Work." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422. When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] }, "example": { "error": { "code": "validation", "message": "The request body is not valid JSON." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds. When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry. When no op of the batch applied, the body also has the `areas`, `activityTypes` and `projects` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "areas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "activityTypes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "forkedFrom": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "pattern": { "type": "string", "enum": [ "solid", "hatch_r", "hatch_l", "cross", "horizontal", "vertical", "grid", "dots", "waves", "chevron" ] } }, "required": [ "id", "name", "pattern" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "movedEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } }, "projects": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "publishCalendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "areaId", "archived", "publishCalendarId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "split": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The new project of the link." }, "name": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fromId": { "type": "string", "minLength": 1, "description": "The shared project that the link left." }, "linkId": { "type": "string", "minLength": 1, "description": "The task list or Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." } }, "required": [ "id", "name", "areaId", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A split: the link feeds a new project \"{name} ({Provider})\" now." } }, "required": [ "split" ], "additionalProperties": false }, { "type": "object", "properties": { "relinked": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project that the Linear project feeds now." }, "fromId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The project that it fed before; null for none." }, "linkId": { "type": "string", "minLength": 1, "description": "The Linear project that moved." }, "movedItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "The Inbox items that moved with the link." }, "noop": { "description": "The Linear project feeds `id` already: nothing changed and no undo receipt.", "type": "boolean", "const": true } }, "required": [ "id", "fromId", "linkId", "movedItems" ], "additionalProperties": false, "description": "A relink: the Linear project feeds `id` now." } }, "required": [ "relinked" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "areas", "activityTypes" ], "additionalProperties": false } ] }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/backlog": { "get": { "operationId": "listBacklog", "summary": "Read the Inbox", "description": "Every Inbox item of the caller in tray order. An item is captured but not placed on the dial. Requires `events:read` or `events:write` (includes read access).", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "backlog": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } } }, "required": [ "backlog" ], "additionalProperties": false }, "example": { "backlog": [ { "id": "e2f3a4b5-c6d7-4e8f-90a1-b2c3d4e5f607", "name": "Book the dentist", "kind": "blocking", "durationMinutes": 30, "areaId": null, "activityTypeId": null, "projectId": null, "priority": 0, "plannedDate": "2026-08-15" } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "post": { "operationId": "manageBacklog", "summary": "Capture, update, schedule, park, or remove Inbox items", "description": "Send 1 to 50 `ops`. Each op names its verb: `capture`, `update`, `schedule`, `park`, or `remove`. `durationMinutes` is a whole number of minutes, 5 to 1440. `kind` is `blocking`, `non_blocking`, or `reference`: `capture` and `update` take it (omitted is `blocking` on capture and no change on update), `park` keeps the event's kind, and `schedule` gives the new event the item's kind. `schedule` places an Inbox item at a local `start` \"YYYY-MM-DDTHH:MM\". `park` moves a dial event (by `id`) back to the Inbox. `schedule` gives the event the length of the item, or 60 minutes when the item has no `durationMinutes`. A blocking item cannot overlap a blocking event or a blocking item that an earlier `schedule` in the same batch places: the op fails with the code `conflict`, and its row `error` has `conflicts` and `nearestSlots`. A `non_blocking` or `reference` item can overlap any event. An earlier `park` in the same batch frees the time of its event. `areaId` and `activityTypeId` take an id or `null`: on `update`, `null` clears the link and an omitted key keeps it; on `capture`, `null` is the same as omitted. `projectId` takes a live project of the caller or `null`, the same way: on `update`, `null` clears the project and keeps the area. When a write changes the project and sets no `areaId`, the item takes the area of the project, also over an area that the user set by hand. `priority` takes an integer from 0 (none) to 4 (urgent) only; `null` is not valid, so send `0` to clear it. On `update`, an omitted `priority` keeps it; on `capture`, it is `0`. A capture returns `{ created }`, an update `{ updated }`, a schedule `{ created: , deletedIds }`, a park `{ created: , deletedIds }`, and a remove `{ deletedIds }`. Requires the `events:write` scope, which also includes read access. Returns `results`, one row per op with its 0-based `index` and a `status` of `ok`, `error`, or `skipped`. An `ok` row has the `result`, an `error` row has `error: { code, message }` (plus `conflicts` and `nearestSlots` on a conflict), and a `skipped` row has the `reason`. When something was written, the body has one `undoToken` and its `expiresAt`. When no op applied, the status is the code that the failed ops share (400 with `batch_rejected` when they differ) and the body adds the `error` envelope.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ops": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "capture" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 1440, "description": "Estimated length in whole minutes, 5 to 1440. Sizes the block when placed." }, "kind": { "description": "The kind the event takes when scheduled: \"blocking\" occupies time, \"non_blocking\" is an overlay that may overlap others, \"reference\" is something to see but not do. Omit for \"blocking\".", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "areaId": { "description": "The area id. null or omitted leaves it unset.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "The activity type id. null or omitted leaves it unset.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the item takes the area of the project, also over an area the user set by hand. On an item linked to a task, the task stays when its list (or Linear project) feeds the new project; else it moves to the one target of that project in the same account (for Linear: open, in the issue team). With 2 or more lists it goes to the \"New tasks go to\" list of the project. Any other case, and a move of a scheduled task, is refused with read_only. A clear is never refused. null or omitted leaves it unset.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit for 0.", "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "description": "The day this intention is planned for (still untimed — placing it on the dial is a separate `schedule`). Groups it under that day in the tray.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "description": "Inclusive end of a planned window; it must fall after plannedDate.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "description": "The block's microtasks, in order — REPLACES the whole list (send every item you want kept; an empty `items` clears them). An Inbox block has no occurrence, so nothing is ticked off until it is scheduled.", "type": "object", "properties": { "items": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Keep an item id from a read; omit for a new item.", "type": "string" }, "text": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "sourceUrl": { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, "calendarId": { "description": "The Source of each item: a writable task list to also create the item in, as an `id` from `get_schedule` `integrations.sources[].calendars[]` of a task source. null keeps the items in Reassign only. Omit it to use the default list of the item's project, else the account default (`defaultCalendarId`), which creates the task when it is a task list. On `capture_text`, an item goes to a list that the text explicitly names (\"add to Todoist Work: …\") instead.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "enrich": { "description": "Let AI clean this capture up before it is saved: propose a better name, estimate durationMinutes, and copy out any microtasks the captured text spells out. For RAW captures only — text grabbed off a web page, where the name is a paragraph rather than an intention. Do NOT set it for something the user typed or dictated: it may RENAME the block, and a name they chose must stand. Fields you send yourself always win; only the name can be replaced.", "type": "boolean" } }, "required": [ "op", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "capture_text" }, "text": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "What the user typed, dictated or selected, as is. AI splits it into 1 to 10 Inbox items, each with a short name, notes, a length and a day when the text names one. Without the AI the first line is the name and the rest are notes." }, "notes": { "description": "Notes added to every item.", "type": "string", "maxLength": 2000 }, "durationMinutes": { "description": "A length for every item. Omit it to keep the AI estimate; send it only when the user chose one.", "type": "integer", "minimum": 5, "maximum": 1440 }, "kind": { "description": "The kind the event takes when scheduled: \"blocking\" occupies time, \"non_blocking\" is an overlay that may overlap others, \"reference\" is something to see but not do. Omit for \"blocking\".", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "areaId": { "description": "The area id. null or omitted leaves it unset.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "The activity type id. null or omitted leaves it unset.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id for every item. When the op sets no areaId, each item takes the area of the project. null or omitted leaves it unset.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "A priority for every item: 0 none, 1 low, 2 medium, 3 high, 4 urgent.", "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "description": "A planned day for every item. Omit it to keep the AI day.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "description": "Inclusive end of a planned window; it must fall after plannedDate.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "sourceUrl": { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, "calendarId": { "description": "The Source of each item: a writable task list to also create the item in, as an `id` from `get_schedule` `integrations.sources[].calendars[]` of a task source. null keeps the items in Reassign only. Omit it to use the default list of the item's project, else the account default (`defaultCalendarId`), which creates the task when it is a task list. On `capture_text`, an item goes to a list that the text explicitly names (\"add to Todoist Work: …\") instead.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "op", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string", "description": "The Inbox block id (from the schedule read's `backlog`)." }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 1440, "description": "Estimated length in whole minutes, 5 to 1440. Sizes the block when placed." }, "kind": { "description": "The kind the event takes when scheduled: \"blocking\" occupies time, \"non_blocking\" is an overlay that may overlap others, \"reference\" is something to see but not do. Omit to keep it.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "areaId": { "description": "The area id. null clears the link; omit to keep it.", "type": [ "string", "null" ] }, "activityTypeId": { "description": "The activity type id. null clears the link; omit to keep it.", "type": [ "string", "null" ] }, "projectId": { "description": "A live project id from get_schedule `projects`. When the project changes and the op sets no areaId, the item takes the area of the project, also over an area the user set by hand. On an item linked to a task, the task stays when its list (or Linear project) feeds the new project; else it moves to the one target of that project in the same account (for Linear: open, in the issue team). With 2 or more lists it goes to the \"New tasks go to\" list of the project. Any other case, and a move of a scheduled task, is refused with read_only. A clear is never refused. null clears the project and keeps the area; omit to keep it.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "description": "0 none, 1 low, 2 medium, 3 high, 4 urgent. Omit to keep it.", "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "description": "Set/move the block's planned day; null clears it back to Someday (also clears any window end). Google Tasks, Microsoft To Do and Linear sync this date both ways. Todoist dates must be changed in Todoist.", "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] }, "plannedUntil": { "description": "Inclusive end of a planned window; it must fall after plannedDate. null collapses the window to one day.", "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] }, "checklist": { "description": "The block's microtasks, in order — REPLACES the whole list (send every item you want kept; an empty `items` clears them). An Inbox block has no occurrence, so nothing is ticked off until it is scheduled.", "type": "object", "properties": { "items": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Keep an item id from a read; omit for a new item.", "type": "string" }, "text": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "sourceUrl": { "description": "Replace where this block was captured from (http(s)); null clears the source chip.", "anyOf": [ { "type": "string", "maxLength": 2048, "description": "Where this was captured from — the http(s) page address. Shown as a source chip; never parsed. Set it only for something grabbed off a real page, not for an intention the user typed." }, { "type": "null" } ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "remove" }, "id": { "type": "string", "description": "The Inbox block id to delete from the Inbox." } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "schedule" }, "id": { "type": "string", "description": "The Inbox block id to place on the dial." }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Local start \"YYYY-MM-DDTHH:MM\"; the block's duration sizes it." }, "recurrence": { "description": "Optionally make the placed block repeat, as an RRULE (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE,FR\"). Omit for a one-off.", "type": "string" } }, "required": [ "op", "id", "start" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "park" }, "id": { "type": "string", "description": "The dial event id to move to the Inbox (from a schedule or search read). Must be a native or owned-calendar one-off that hasn't been reviewed." } }, "required": [ "op", "id" ], "additionalProperties": false } ] } }, "partial": { "description": "Best-effort mode instead of the default all-or-nothing.", "type": "boolean" } }, "required": [ "ops" ], "additionalProperties": false }, "example": { "ops": [ { "op": "capture", "name": "Call the bank", "durationMinutes": 30, "calendarId": null }, { "op": "schedule", "id": "e2f3a4b5-c6d7-4e8f-90a1-b2c3d4e5f607", "start": "2026-08-15T11:00" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1 }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "results" ], "additionalProperties": false }, "example": { "timezone": "Europe/Ljubljana", "results": [ { "index": 0, "status": "ok", "result": { "created": { "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6", "name": "Call the bank", "kind": "blocking", "durationMinutes": 30, "areaId": null, "activityTypeId": null, "projectId": null, "priority": 0 } } }, { "index": 1, "status": "ok", "result": { "created": { "id": "b7f1c2a0-1d2e-4f3a-9b8c-5d6e7f801234", "start": "2026-08-15T11:00", "end": "2026-08-15T11:30", "kind": "blocking", "name": "Book the dentist", "source": "reassign", "areaId": null, "activityTypeId": null, "projectId": null, "priority": 0 }, "deletedIds": [ "e2f3a4b5-c6d7-4e8f-90a1-b2c3d4e5f607" ] } } ] } } } }, "400": { "description": "Every op failed, and the failed ops have different codes. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed. The code is `batch_rejected`.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\" A rejected batch also answers 403 when every failed op has the same code: `read_only` (an `update` changes the planned day of an item that a task app owns) or `permission` (a `park` names a recurring, sleep, reviewed, or not-owned calendar event). When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "An op names an item that does not exist. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] } } } }, "409": { "description": "The request conflicts with the current state: `conflict` \"The time overlaps an existing event.\" or `conflict` \"The time overlaps an earlier op in this batch.\" When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "conflict", "message": "The time overlaps an existing event." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "validation", "message": "`ops`: Invalid input: expected array, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry. When no op of the batch applied, the body also has the `results` rows, so the caller sees which op failed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false }, "timezone": { "type": "string", "minLength": 1 }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "ok" }, "result": { "anyOf": [ { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "enriched": { "type": "array", "items": { "type": "string", "enum": [ "name", "durationMinutes", "checklist" ] } } }, "required": [ "created" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "ai", "text" ] } }, "required": [ "created", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "firstOccurrence": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "sourceUrl": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "plannedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "plannedUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" } }, "required": [ "id", "text" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } }, "required": [ "id", "name", "kind", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "created", "deletedIds" ], "additionalProperties": false }, { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false } ] }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "classification_pending" ] } } }, "required": [ "index", "status", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false }, "conflicts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" } }, "required": [ "start", "end", "id", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "batchIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "required": [ "start", "end", "batchIndex", "name" ], "additionalProperties": false } ] } }, "nearestSlots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "score": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "status", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string" } }, "required": [ "index", "status", "reason" ], "additionalProperties": false } ] } } }, "required": [ "error", "results" ], "additionalProperties": false } ] }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/reviews/{date}": { "post": { "operationId": "reviewDay", "summary": "Confirm or discard a day's reflection", "description": "`action` is `\"confirm\"` (freeze the adherence snapshot of the day) or `\"discard\"` (reset the whole reflection). A confirm needs a day before today in the user's timezone; today or a later day gets a 422 `validation` error with the message \"You can only reflect on a past day — pick a date before today.\" A discard works on any day. A confirm returns the review block of the day. A discard returns `{ date, timezone, updated, deletedIds }`: `updated` has the planned events that it reset, with their spans in `timezone`, and `deletedIds` the events that only the reflection added. A discard of a day with no review and no marks returns empty lists and no `undoToken`. A confirm of a day where no event has a reflection mark also has a `warning`: the score counts each unmarked event as kept. When the day had no planned time, `adherence.event` and `adherence.layer` are null. `adherence.layer` is also null when no planned time had an area. The `undoToken` reverses either action before its `expiresAt`. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "date", "in": "path", "required": true, "description": "The day, ISO \"YYYY-MM-DD\".", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "confirm", "discard" ], "description": "\"confirm\" freezes the adherence snapshot of the day; \"discard\" resets the whole reflection." } }, "required": [ "action" ], "additionalProperties": false }, "example": { "action": "confirm" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "reviewedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "adherence": { "type": "object", "properties": { "event": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "layer": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unplannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byArea": { "type": "array", "items": { "type": "object", "properties": { "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "adherence": { "type": "number", "minimum": 0, "maximum": 1 }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "areaId", "adherence", "plannedMinutes" ], "additionalProperties": false } }, "byActivityType": { "type": "array", "items": { "type": "object", "properties": { "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "adherence": { "type": "number", "minimum": 0, "maximum": 1 }, "plannedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "activityTypeId", "adherence", "plannedMinutes" ], "additionalProperties": false } } }, "required": [ "event", "layer", "plannedMinutes", "unplannedMinutes", "byArea", "byActivityType" ], "additionalProperties": false }, "warning": { "type": "string" }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "required": [ "date", "reviewedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "minLength": 1 }, "updated": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority" ], "additionalProperties": false } }, "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "noop": { "type": "boolean", "const": true }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "required": [ "date", "timezone", "updated", "deletedIds" ], "additionalProperties": false } ] }, "example": { "date": "2026-08-12", "reviewedAt": "2026-08-13T07:12:00.000Z", "adherence": { "event": 0.8, "layer": 0.74, "plannedMinutes": 450, "unplannedMinutes": 60, "byArea": [ { "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "adherence": 0.9, "plannedMinutes": 300 } ], "byActivityType": [ { "activityTypeId": null, "adherence": 0.8, "plannedMinutes": 450 } ] }, "undoToken": "00000000-0000-4000-8000-000000000001", "expiresAt": "2026-08-13T09:12:00.000Z" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`action`: Invalid option: expected one of \"confirm\"|\"discard\"" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/weather": { "get": { "operationId": "getWeather", "summary": "Read the weather report for a day", "description": "A short prose weather report for one day, to plan outdoor blocks. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "date", "in": "query", "required": false, "description": "The day; defaults to today.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "location", "in": "query", "required": false, "description": "A place name; defaults to the saved city.", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "report": { "type": "string", "minLength": 1 } }, "required": [ "report" ], "additionalProperties": false }, "example": { "report": "Weather for Ljubljana on Thursday, 2026-08-13 (today):\n• Clear, 16–25°C\n• Rain likely 15:00–17:00 (70% peak)\n• Daylight 06:06–20:15\n Morning: 19°C, clear\n Afternoon: 24°C, rain\n Evening: 25°C, clear\n Night: 16°C, clear" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Repeated query parameter `date`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/energy": { "get": { "operationId": "getEnergy", "summary": "Read the forecast energy curve for a day", "description": "A prose overview of the forecast energy curve, with the peaks and dips to plan around. Without logged sleep, the report asks the user to log sleep. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "date", "in": "query", "required": false, "description": "The day; defaults to today.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "report": { "type": "string", "minLength": 1 } }, "required": [ "report" ], "additionalProperties": false }, "example": { "report": "Energy for Thursday, 2026-08-13 (today):\n• Peaks: morning ~09:24, evening ~18:36\n• Afternoon dip ~14:15\n• Morning grogginess until ~08:15\n• Right now (~10:42): 71/100: body clock strong, well rested\n• Peak today ~75/100.\n• Population estimate. Log how your energy feels (a Mood/energy moment) to personalize it." } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Repeated query parameter `date`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/trackers": { "get": { "operationId": "getTrackers", "summary": "List the moment trackers", "description": "Every tracker that the user can log against (their own trackers and the shared defaults), with the scale data that a client needs to show the right input: `tally` (each log adds `step`), `rating` (a bounded scale from `ratingMin` to `ratingMax`), or `quantity` (an amount in `unit`). Requires `events:read` or `events:write` (includes read access).", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "trackers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "scale": { "type": "string", "enum": [ "tally", "rating", "quantity" ] }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit": { "type": "string" }, "step": { "type": "number" }, "ratingMin": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ratingMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "target": { "type": "number" }, "isGlobal": { "type": "boolean" }, "overridesId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The global tracker this one replaces; null when none." }, "energyImpact": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "number" }, "energyRole": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "string" }, "energyKernel": { "type": "object", "properties": { "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" }, "rebound": { "anyOf": [ { "type": "object", "properties": { "delay": { "type": "number" }, "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" } }, "required": [ "delay", "X", "tauAbs", "tauElim" ], "additionalProperties": false }, { "type": "null" } ] }, "note": { "type": [ "string", "null" ] } }, "required": [ "X", "tauAbs", "tauElim" ], "additionalProperties": false } }, "required": [ "id", "name", "icon", "color", "scale", "order", "isGlobal", "overridesId" ], "additionalProperties": false } } }, "required": [ "trackers" ], "additionalProperties": false }, "example": { "trackers": [ { "id": "00000000-0000-4000-8000-000000000010", "name": "Coffee", "icon": "coffee", "color": "#8b5cf6", "scale": "tally", "order": 0, "step": 1, "isGlobal": false, "overridesId": null }, { "id": "00000000-0000-4000-8000-000000000012", "name": "Mood", "icon": "smile", "color": "#f59e0b", "scale": "rating", "order": 1, "ratingMin": 1, "ratingMax": 5, "isGlobal": false, "overridesId": null } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "post": { "operationId": "createTracker", "summary": "Create a moment tracker", "description": "Create one owned tracker to log against. `scale` is `tally`, `rating` (with `ratingMin`/`ratingMax`), or `quantity` (with `unit`/`step`). A `color` that is not a lowercase \"#rrggbb\", or a `ratingMin` above `ratingMax`, returns 422. Requires the `events:write` scope, which also includes read access.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "The tracker name, 1 to 60 characters." }, "scale": { "type": "string", "enum": [ "tally", "rating", "quantity" ], "description": "`tally` counts: a log without `value` adds the read `step`, 1 when absent (a write cannot set `step` on a tally). `rating` is a bounded scale. `quantity` is an amount in `unit`; a log without `value` adds `step`." }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "unit": { "description": "Only with scale `quantity`.", "type": [ "string", "null" ] }, "step": { "type": "number", "exclusiveMinimum": 0, "description": "Only with scale `quantity`." }, "ratingMin": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Only with scale `rating`." }, "ratingMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Only with scale `rating`." } }, "required": [ "name", "scale" ], "additionalProperties": false }, "example": { "name": "Water", "color": "#38bdf8", "scale": "quantity", "unit": "ml", "step": 250 } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "scale": { "type": "string", "enum": [ "tally", "rating", "quantity" ] }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit": { "type": "string" }, "step": { "type": "number" }, "ratingMin": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ratingMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "target": { "type": "number" }, "isGlobal": { "type": "boolean" }, "overridesId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The global tracker this one replaces; null when none." }, "energyImpact": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "number" }, "energyRole": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "string" }, "energyKernel": { "type": "object", "properties": { "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" }, "rebound": { "anyOf": [ { "type": "object", "properties": { "delay": { "type": "number" }, "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" } }, "required": [ "delay", "X", "tauAbs", "tauElim" ], "additionalProperties": false }, { "type": "null" } ] }, "note": { "type": [ "string", "null" ] } }, "required": [ "X", "tauAbs", "tauElim" ], "additionalProperties": false } }, "required": [ "id", "name", "icon", "color", "scale", "order", "isGlobal", "overridesId" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, "example": { "created": { "id": "00000000-0000-4000-8000-000000000013", "name": "Water", "icon": "", "color": "#38bdf8", "scale": "quantity", "order": 2, "unit": "ml", "step": 250, "isGlobal": false, "overridesId": null } } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`name`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/trackers/{id}": { "patch": { "operationId": "patchTracker", "summary": "Edit a moment tracker", "description": "Edit the name, colour, scale or scale data of a tracker. An edit of a shared default tracker makes a private copy with a new `id`. A `color` that is not a lowercase \"#rrggbb\", or a `ratingMin` above `ratingMax`, returns 422. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id of the tracker.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "The tracker name, 1 to 60 characters." }, "scale": { "type": "string", "enum": [ "tally", "rating", "quantity" ], "description": "`tally` counts: a log without `value` adds the read `step`, 1 when absent (a write cannot set `step` on a tally). `rating` is a bounded scale. `quantity` is an amount in `unit`; a log without `value` adds `step`." }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "unit": { "description": "Only with scale `quantity`.", "type": [ "string", "null" ] }, "step": { "type": "number", "exclusiveMinimum": 0, "description": "Only with scale `quantity`." }, "ratingMin": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Only with scale `rating`." }, "ratingMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Only with scale `rating`." } }, "additionalProperties": false }, "example": { "name": "Water intake", "color": "#0ea5e9" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string", "pattern": "^#[0-9a-f]{6}$" }, "scale": { "type": "string", "enum": [ "tally", "rating", "quantity" ] }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit": { "type": "string" }, "step": { "type": "number" }, "ratingMin": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ratingMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "target": { "type": "number" }, "isGlobal": { "type": "boolean" }, "overridesId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "The global tracker this one replaces; null when none." }, "energyImpact": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "number" }, "energyRole": { "description": "Read-only legacy value. Nothing writes it now; `energyKernel` is the energy effect.", "type": "string" }, "energyKernel": { "type": "object", "properties": { "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" }, "rebound": { "anyOf": [ { "type": "object", "properties": { "delay": { "type": "number" }, "X": { "type": "number" }, "tauAbs": { "type": "number" }, "tauElim": { "type": "number" } }, "required": [ "delay", "X", "tauAbs", "tauElim" ], "additionalProperties": false }, { "type": "null" } ] }, "note": { "type": [ "string", "null" ] } }, "required": [ "X", "tauAbs", "tauElim" ], "additionalProperties": false } }, "required": [ "id", "name", "icon", "color", "scale", "order", "isGlobal", "overridesId" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, "example": { "updated": { "id": "00000000-0000-4000-8000-000000000013", "name": "Water intake", "icon": "", "color": "#0ea5e9", "scale": "quantity", "order": 2, "unit": "ml", "step": 250, "isGlobal": false, "overridesId": null } } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "Tracker not found." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`body`: Pass at least one field." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "delete": { "operationId": "archiveTracker", "summary": "Archive a moment tracker", "description": "Archive a tracker. It leaves the list, and its logged entries stay readable. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id of the tracker.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, "example": { "deletedIds": [ "00000000-0000-4000-8000-000000000010" ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "Tracker not found." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/moments": { "get": { "operationId": "getMoments", "summary": "Read the logged moments of a day range", "description": "The entries logged from `from` to `to` (inclusive, equal for one day, at most 366 days). `time` is a local datetime \"YYYY-MM-DDTHH:MM\". `value` is the effective value (the stored one, else the default of the tracker). `note` is present only when set. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "The first day, inclusive.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "description": "The last day, inclusive; the range is at most 366 days. Equal to `from` for one day.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "trackerId": { "type": "string", "minLength": 1 }, "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "value": { "type": "number" }, "note": { "type": "string", "minLength": 1 } }, "required": [ "id", "trackerId", "time", "value" ], "additionalProperties": false } } }, "required": [ "entries" ], "additionalProperties": false }, "example": { "entries": [ { "id": "00000000-0000-4000-8000-000000000011", "trackerId": "00000000-0000-4000-8000-000000000010", "time": "2026-08-13T09:30", "value": 1, "note": "double shot" } ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`from`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "delete": { "operationId": "clearMoments", "summary": "Clear the logged moments of a day range", "description": "Delete every entry logged from `from` to `to` (inclusive). Both are required, because this delete has no undo. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "The first day, inclusive.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "description": "The last day, inclusive; the range is at most 366 days. Equal to `from` for one day.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, "example": { "deletedIds": [ "00000000-0000-4000-8000-000000000011" ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`from`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "post": { "operationId": "logMoment", "summary": "Log a moment", "description": "Record one entry against a tracker. A body with only `{ trackerId }` is a quick tap: `time` is now and `value` is the default of the tracker (the midpoint of a rating, else one step). Requires the `events:write` scope, which also includes read access.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "trackerId": { "type": "string", "minLength": 1, "description": "The tracker to log against." }, "time": { "description": "When it happened; now if absent.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "value": { "description": "The value; the tracker default if absent.", "type": "number" }, "note": { "type": "string", "maxLength": 1000 } }, "required": [ "trackerId" ], "additionalProperties": false }, "example": { "trackerId": "00000000-0000-4000-8000-000000000010", "time": "2026-08-13T09:30", "note": "double shot" } } } }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "trackerId": { "type": "string", "minLength": 1 }, "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "value": { "type": "number" }, "note": { "type": "string", "minLength": 1 } }, "required": [ "id", "trackerId", "time", "value" ], "additionalProperties": false } }, "required": [ "created" ], "additionalProperties": false }, "example": { "created": { "id": "00000000-0000-4000-8000-000000000011", "trackerId": "00000000-0000-4000-8000-000000000010", "time": "2026-08-13T09:30", "value": 1, "note": "double shot" } } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "No tracker with that id. Read GET /api/v1/trackers for the list." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`trackerId`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/moments/{id}": { "patch": { "operationId": "updateMoment", "summary": "Edit a logged moment", "description": "Change the `time`, `value` or `note` of one logged entry. A field that is not in the body keeps its value; `note: null` clears the note. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id of the logged entry.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "value": { "type": "number" }, "note": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "additionalProperties": false }, "example": { "time": "2026-08-13T10:15", "value": 2 } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "trackerId": { "type": "string", "minLength": 1 }, "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "value": { "type": "number" }, "note": { "type": "string", "minLength": 1 } }, "required": [ "id", "trackerId", "time", "value" ], "additionalProperties": false } }, "required": [ "updated" ], "additionalProperties": false }, "example": { "updated": { "id": "00000000-0000-4000-8000-000000000011", "trackerId": "00000000-0000-4000-8000-000000000010", "time": "2026-08-13T10:15", "value": 2, "note": "double shot" } } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "No logged entry with that id." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`body`: Pass `time`, `value` or `note`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } }, "delete": { "operationId": "deleteMoment", "summary": "Delete a logged moment", "description": "Remove one logged entry (undo a mislog). The tracker itself does not change. Requires the `events:write` scope, which also includes read access.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id of the logged entry.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "deletedIds" ], "additionalProperties": false }, "example": { "deletedIds": [ "00000000-0000-4000-8000-000000000011" ] } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "404": { "description": "The resource that the request names does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "not_found", "message": "No logged entry with that id." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/command": { "post": { "operationId": "runCommand", "summary": "Run an AI quick command", "description": "The command bar over HTTP. `mode` is `\"line\"` (one free-form line, the default) or `\"braindump\"` (many lines). The input becomes events, Inbox items and logged moments, based on the schedule of the day, the taxonomy of the user and their AI rules. Then the command applies them. `apply: false` returns the plan and writes nothing. A question (\"how much free time today?\") gets its answer in `notices` and writes nothing. To link each new event and Inbox block to a web page, send `sourceUrl` (an http(s) address). To refer to an earlier line (\"move that one later\"), send `history`: the earlier `{ user, plan }` turns that the client keeps, with one line per proposed action in `plan`. History is context only: the model reads each history plan as a proposal that is not applied yet. The model returns the full updated plan, so `intents` repeats the proposals of the last turn that still hold, and the command applies them with the new line. A change that a turn applied is in the events of the day, so leave that turn out of `history`. When a turn applied a part of a line and asked about the rest, keep that turn and name the applied part in its `written`: the model does not emit that part again. The response has the resolved `intents` in the same shapes as the write ops (a span is `start` + `end` as local datetimes \"YYYY-MM-DDTHH:MM\", a length is `durationMinutes`, a moment has `time`), `questions` that the client resolves, `notices`, `created` (each new event with its span, and each new Inbox block, with its `entity`, `kind`, `areaId` and `activityTypeId`), `written` (the indexes in `intents` that the command wrote; an intent that is not there was refused), `writtenLines` (one line for each written intent, with the name of its event; join them with newlines for the `written` of the next history turn), and one `undoToken` + `expiresAt` when something was written. The command refuses to delete a calendar-synced event or to move it to the Inbox. The command drops an intent with a value out of bounds and adds a notice. A `log_moment` rating outside the range of the tracker gets \"A log was skipped because its value is not from to .\" A new `park` item with a length outside 5 to 1440 minutes gets '\"\" was not added to the Inbox because its length of minutes is not from 5 to 1440.' When the model call fails, the response is 503 `internal`, not an empty plan. Needs Reassign Pro. The 7-day free trial includes it. Requires the `events:write` scope, which also includes read access.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string", "minLength": 1, "description": "The command line or braindump." }, "mode": { "description": "\"line\" (the default) or \"braindump\" (many lines).", "type": "string", "enum": [ "line", "braindump" ] }, "date": { "description": "The day of the command; today if absent.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "apply": { "description": "`false` returns the plan and writes nothing.", "type": "boolean" }, "history": { "description": "The earlier `{ user, plan }` turns, so a line can refer back. `written` names what that turn already wrote, so the reply does not write it again.", "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string" }, "plan": { "type": "string" }, "written": { "type": "string" } }, "required": [ "user", "plan" ], "additionalProperties": false } }, "sourceUrl": { "description": "The page the command was captured from; each new event and Inbox block links to it.", "type": "string", "maxLength": 2048 } }, "required": [ "input" ], "additionalProperties": false }, "example": { "input": "also coffee with Ana noon, park: write the offsite agenda", "mode": "braindump", "history": [ { "user": "gym at 7, deep work 9-11", "plan": "create \"Gym\" 2026-08-13T07:00 to 2026-08-13T08:00\ncreate \"Deep work\" 2026-08-13T09:00 to 2026-08-13T11:00 (area Work)" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "intents": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "op": { "type": "string", "const": "create" }, "name": { "type": "string", "minLength": 1 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "recurrence": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "calendarId": { "description": "The home calendar id. Absent: the account's default calendar if one is set, else the event stays on the dial only.", "type": "string", "minLength": 1 }, "checklist": { "description": "Checklist items of the new event.", "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "projectId": { "description": "The project of the new item. Absent: no project. A project with an area also sets that area.", "type": "string", "minLength": 1 }, "priority": { "description": "The priority of the new item: 4 urgent, 3 high, 2 medium, 1 low. Absent: none.", "type": "integer", "minimum": 1, "maximum": 4 } }, "required": [ "start", "end", "op", "name", "areaId", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string", "minLength": 1 }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "ripple": { "type": "boolean" }, "focusIntervals": { "anyOf": [ { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, { "type": "null" } ] }, "kind": { "description": "A new kind; sent only when the user asks for it.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "end": { "description": "A new end after the (new) start: it resizes the event.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 }, "appendNote": { "description": "One line added to the end of the notes.", "type": "string", "minLength": 1, "maxLength": 1000 }, "notes": { "description": "Notes that replace the old ones; \"\" clears them.", "type": "string", "maxLength": 1000 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "shift" }, "id": { "type": "string", "minLength": 1 }, "byMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ripple": { "type": "boolean" } }, "required": [ "op", "id", "byMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string", "minLength": 1 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "clear" }, "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "op", "from", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "park" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "description": "The project of the new item. Absent: no project. A project with an area also sets that area.", "type": "string", "minLength": 1 }, "priority": { "description": "The priority of the new item: 4 urgent, 3 high, 2 medium, 1 low. Absent: none.", "type": "integer", "minimum": 1, "maximum": 4 } }, "required": [ "op", "name", "areaId", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "log_moment" }, "mood": { "type": "boolean" }, "trackerId": { "type": "string", "minLength": 1 }, "value": { "type": "number" }, "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "op" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist" }, "id": { "type": "string", "minLength": 1 }, "add": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "target": { "type": "string", "const": "backlog" }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id", "add" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist_edit" }, "id": { "type": "string", "minLength": 1 }, "item": { "type": "string", "minLength": 1 }, "edit": { "type": "string", "enum": [ "check", "uncheck", "rename", "remove" ] }, "newText": { "description": "The new item text; only with `edit: \"rename\"`.", "type": "string", "minLength": 1 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id", "item", "edit" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "split" }, "id": { "type": "string", "minLength": 1 }, "at": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "secondName": { "description": "The name of the second part. Absent: the same name.", "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "op", "id", "at" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "remember" }, "text": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "op", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "reflect" }, "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] }, "id": { "description": "The event; absent only with `status: \"added\"`.", "type": "string", "minLength": 1 }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "name": { "description": "The name of an `\"added\"` event.", "type": "string", "minLength": 1, "maxLength": 200 }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 } }, "required": [ "op", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "day_note" }, "wentWell": { "type": "string", "minLength": 1, "maxLength": 500 }, "wentBadly": { "type": "string", "minLength": 1, "maxLength": 500 }, "lesson": { "type": "string", "minLength": 1, "maxLength": 500 }, "replace": { "type": "boolean" } }, "required": [ "op" ], "additionalProperties": false } ] } }, "questions": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "target" }, "question": { "type": "string" }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "op": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "ripple": { "type": "boolean" }, "focusIntervals": { "anyOf": [ { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, { "type": "null" } ] }, "kind": { "description": "A new kind; sent only when the user asks for it.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "end": { "description": "A new end after the (new) start: it resizes the event.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 }, "appendNote": { "description": "One line added to the end of the notes.", "type": "string", "minLength": 1, "maxLength": 1000 }, "notes": { "description": "Notes that replace the old ones; \"\" clears them.", "type": "string", "maxLength": 1000 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "shift" }, "byMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ripple": { "type": "boolean" } }, "required": [ "op", "byMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "park" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "description": "The project of the new item. Absent: no project. A project with an area also sets that area.", "type": "string", "minLength": 1 }, "priority": { "description": "The priority of the new item: 4 urgent, 3 high, 2 medium, 1 low. Absent: none.", "type": "integer", "minimum": 1, "maximum": 4 } }, "required": [ "op", "name", "areaId", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist" }, "add": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "target": { "type": "string", "const": "backlog" }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "add" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist_edit" }, "item": { "type": "string", "minLength": 1 }, "edit": { "type": "string", "enum": [ "check", "uncheck", "rename", "remove" ] }, "newText": { "description": "The new item text; only with `edit: \"rename\"`.", "type": "string", "minLength": 1 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "item", "edit" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "split" }, "at": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "secondName": { "description": "The name of the second part. Absent: the same name.", "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "op", "at" ], "additionalProperties": false } ] } }, "required": [ "kind", "question", "candidates", "op" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "choice" }, "question": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "ops": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "op": { "type": "string", "const": "create" }, "name": { "type": "string", "minLength": 1 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "recurrence": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "calendarId": { "description": "The home calendar id. Absent: the account's default calendar if one is set, else the event stays on the dial only.", "type": "string", "minLength": 1 }, "checklist": { "description": "Checklist items of the new event.", "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "projectId": { "description": "The project of the new item. Absent: no project. A project with an area also sets that area.", "type": "string", "minLength": 1 }, "priority": { "description": "The priority of the new item: 4 urgent, 3 high, 2 medium, 1 low. Absent: none.", "type": "integer", "minimum": 1, "maximum": 4 } }, "required": [ "start", "end", "op", "name", "areaId", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "update" }, "id": { "type": "string", "minLength": 1 }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "ripple": { "type": "boolean" }, "focusIntervals": { "anyOf": [ { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, { "type": "null" } ] }, "kind": { "description": "A new kind; sent only when the user asks for it.", "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "end": { "description": "A new end after the (new) start: it resizes the event.", "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 }, "appendNote": { "description": "One line added to the end of the notes.", "type": "string", "minLength": 1, "maxLength": 1000 }, "notes": { "description": "Notes that replace the old ones; \"\" clears them.", "type": "string", "maxLength": 1000 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "shift" }, "id": { "type": "string", "minLength": 1 }, "byMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ripple": { "type": "boolean" } }, "required": [ "op", "id", "byMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "delete" }, "id": { "type": "string", "minLength": 1 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "clear" }, "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "op", "from", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "park" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "description": "The project of the new item. Absent: no project. A project with an area also sets that area.", "type": "string", "minLength": 1 }, "priority": { "description": "The priority of the new item: 4 urgent, 3 high, 2 medium, 1 low. Absent: none.", "type": "integer", "minimum": 1, "maximum": 4 } }, "required": [ "op", "name", "areaId", "activityTypeId" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "log_moment" }, "mood": { "type": "boolean" }, "trackerId": { "type": "string", "minLength": 1 }, "value": { "type": "number" }, "time": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "op" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist" }, "id": { "type": "string", "minLength": 1 }, "add": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "target": { "type": "string", "const": "backlog" }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id", "add" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "checklist_edit" }, "id": { "type": "string", "minLength": 1 }, "item": { "type": "string", "minLength": 1 }, "edit": { "type": "string", "enum": [ "check", "uncheck", "rename", "remove" ] }, "newText": { "description": "The new item text; only with `edit: \"rename\"`.", "type": "string", "minLength": 1 }, "scope": { "description": "On a recurring event: \"occurrence\" = this day only, \"series\" = every occurrence, \"future\" = this day and every later one. A one-off event ignores it.", "type": "string", "enum": [ "occurrence", "series", "future" ] } }, "required": [ "op", "id", "item", "edit" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "split" }, "id": { "type": "string", "minLength": 1 }, "at": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "secondName": { "description": "The name of the second part. Absent: the same name.", "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "op", "id", "at" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "remember" }, "text": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "op", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "reflect" }, "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] }, "id": { "description": "The event; absent only with `status: \"added\"`.", "type": "string", "minLength": 1 }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "name": { "description": "The name of an `\"added\"` event.", "type": "string", "minLength": 1, "maxLength": 200 }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 } }, "required": [ "op", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "const": "day_note" }, "wentWell": { "type": "string", "minLength": 1, "maxLength": 500 }, "wentBadly": { "type": "string", "minLength": 1, "maxLength": 500 }, "lesson": { "type": "string", "minLength": 1, "maxLength": 500 }, "replace": { "type": "boolean" } }, "required": [ "op" ], "additionalProperties": false } ] } } }, "required": [ "label", "ops" ], "additionalProperties": false } } }, "required": [ "kind", "question", "options" ], "additionalProperties": false } ] } }, "notices": { "type": "array", "items": { "type": "string" } }, "reply": { "description": "The assistant's short plain-text answer, for example to a question about the plan. Absent when it said nothing.", "type": "string", "maxLength": 400 }, "created": { "description": "Each new event (with its span) and Inbox block, with its kind, area and activity type. Absent when nothing was made.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "entity": { "type": "string", "enum": [ "event", "inbox" ] }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "areaId": { "type": "string", "minLength": 1 }, "activityTypeId": { "type": "string", "minLength": 1 }, "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "id", "entity", "name", "kind" ], "additionalProperties": false } }, "written": { "description": "The indexes in `intents` that were written. An intent that is not here was refused; a notice says why. Absent when nothing was written.", "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "writtenLines": { "description": "One line for each written intent, in the order of `written`, with the name of its event. Join them with newlines for the `written` of the next history turn. Absent when nothing was written.", "type": "array", "items": { "type": "string" } }, "undoToken": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "required": [ "date", "intents", "questions", "notices" ], "additionalProperties": false }, "example": { "date": "2026-08-13", "intents": [ { "op": "create", "name": "Gym", "start": "2026-08-13T07:00", "end": "2026-08-13T08:00", "areaId": null, "activityTypeId": null }, { "op": "create", "name": "Deep work", "start": "2026-08-13T09:00", "end": "2026-08-13T11:00", "areaId": "3c9d2a41-6b7e-4f80-9a1b-2c3d4e5f6071", "activityTypeId": null }, { "op": "create", "name": "Coffee with Ana", "start": "2026-08-13T12:00", "end": "2026-08-13T13:00", "areaId": null, "activityTypeId": null }, { "op": "park", "name": "Write the offsite agenda", "durationMinutes": 60, "areaId": null, "activityTypeId": null } ], "questions": [], "notices": [], "undoToken": "00000000-0000-4000-8000-000000000001", "expiresAt": "2026-08-13T09:12:00.000Z" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:write` gets `scope` \"This token is not authorized to modify events (missing events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to modify events (missing events:write scope)." } } } } }, "422": { "description": "The request body is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`input`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/me": { "get": { "operationId": "getMe", "summary": "Who this token is", "description": "The identity of the caller: `id`, `email`, the effective `plan` with `trialEndsAt`, the Checkout `offer` (`kind` paynow | entitled), the paid `subscription` (`provider` web | apple, `status` active | past_due | canceled, `currentPeriodEndsAt`, `cancelAtPeriodEnd`), `emailSubscribed`, the `scopes` of the token and `auth` (`via` pat | oauth | session, with the OAuth `clientId`). Any valid token can read it, whatever its scopes. A client reads this on first run instead of a probe for a 403.", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "plan": { "type": "string", "enum": [ "trial", "pro", "none" ] }, "trialEndsAt": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, { "type": "null" } ] }, "subscription": { "anyOf": [ { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "web", "apple" ] }, "status": { "type": "string", "enum": [ "active", "past_due", "canceled" ] }, "currentPeriodEndsAt": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" } }, "required": [ "provider", "status", "currentPeriodEndsAt", "cancelAtPeriodEnd" ], "additionalProperties": false }, { "type": "null" } ] }, "email": { "type": [ "string", "null" ] }, "offer": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "paynow", "entitled" ] } }, "required": [ "kind" ], "additionalProperties": false }, "emailSubscribed": { "type": "boolean" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "events:read", "events:write" ] } }, "auth": { "type": "object", "properties": { "via": { "type": "string", "enum": [ "oauth", "pat", "session" ] }, "clientId": { "type": "string" } }, "required": [ "via" ], "additionalProperties": false } }, "required": [ "id", "plan", "trialEndsAt", "subscription", "email", "offer", "emailSubscribed", "scopes", "auth" ], "additionalProperties": false }, "example": { "id": "00000000-0000-4000-8000-000000000042", "email": "user@example.com", "plan": "pro", "trialEndsAt": null, "offer": { "kind": "entitled" }, "subscription": { "provider": "web", "status": "active", "currentPeriodEndsAt": "2026-09-13T08:00:00.000Z", "cancelAtPeriodEnd": false }, "emailSubscribed": true, "scopes": [ "events:read", "events:write" ], "auth": { "via": "oauth", "clientId": "reassign-ios" } } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "permission", "message": "Cross-origin request." } } } } }, "422": { "description": "The request has a query parameter; this operation takes none.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "Unknown query parameter `q`." } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } }, "/api/v1/events/search": { "get": { "operationId": "searchEvents", "summary": "Find events by text", "description": "Find events by name. The match uses the event name only, not the notes. `query` is required. `from` and `to` set the date window (by default one week back and 30 days on), `areaId` and `activityTypeId` filter, and `timeOfDay` keeps only the events that start in that part of the day. Each event has its name match `score`, from 0 to 1 (1 is an exact match). `ambiguous` is true when more than one event matches equally well. Requires `events:read` or `events:write` (includes read access).", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Text to match against event names, e.g. \"standup\", \"gym\".", "schema": { "type": "string", "minLength": 1 } }, { "name": "from", "in": "query", "required": false, "description": "Range start, ISO date, e.g. \"2026-06-01\". Defaults to 7 days ago.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": false, "description": "Range end, ISO date, e.g. \"2026-07-01\". Defaults to +30 days.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "areaId", "in": "query", "required": false, "description": "Only match events linked to this area id.", "schema": { "type": "string" } }, { "name": "activityTypeId", "in": "query", "required": false, "description": "Only match events linked to this activity-type id.", "schema": { "type": "string" } }, { "name": "timeOfDay", "in": "query", "required": false, "description": "Only match events that start in this part of the day.", "schema": { "type": "string", "enum": [ "morning", "afternoon", "evening", "night" ] } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "end": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "id": { "type": "string", "minLength": 1 }, "seriesId": { "type": "string", "minLength": 1 }, "originalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "kind": { "type": "string", "enum": [ "blocking", "non_blocking", "reference" ] }, "name": { "type": "string" }, "notes": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "google", "google_tasks", "linear", "microsoft", "microsoft_todo", "ticktick", "todoist", "reassign" ] }, "sourceUrl": { "type": "string" }, "meeting": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false }, "recurrence": { "type": "string" }, "warning": { "type": "string" }, "areaId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "activityTypeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "priority": { "type": "integer", "minimum": 0, "maximum": 4 }, "calendarId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "mirrorCalendarIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "mirrorStyles": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "enum": [ "full", "private", "busy" ] } }, "readOnly": { "type": "boolean", "const": true }, "focusIntervals": { "type": "object", "properties": { "focusMin": { "type": "integer", "minimum": 5, "maximum": 180 }, "breakMin": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "focusMin", "breakMin" ], "additionalProperties": false }, "completedFocusIntervals": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "checklist": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "id", "text", "done" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "reflect": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "kept", "skipped", "changed", "added" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "changed" }, "actualStart": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" }, "actualEnd": { "type": "string", "pattern": "^(\\d{4}-\\d{2}-\\d{2})T([01]\\d|2[0-3]):([0-5]\\d)$" } }, "required": [ "status", "actualStart", "actualEnd" ], "additionalProperties": false } ] }, "score": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "start", "end", "id", "kind", "name", "source", "areaId", "activityTypeId", "projectId", "priority", "score" ], "additionalProperties": false } }, "ambiguous": { "type": "boolean" }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "events", "ambiguous", "timezone" ], "additionalProperties": false }, "example": { "events": [], "ambiguous": false, "timezone": "Europe/Ljubljana" } } } }, "401": { "description": "No Bearer token and no session cookie, or the token is invalid, expired, or revoked. The response carries a `WWW-Authenticate` challenge that points at the protected-resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "unauthorized", "message": "Authentication required." } } } } }, "403": { "description": "A token without `events:read` or `events:write` gets `scope` \"This token is not authorized to read events (requires events:read or events:write scope).\" An account without Reassign Pro access gets `permission` \"Reassign needs an active subscription.\" The 7-day free trial includes Reassign Pro. A cookie session from another site gets `permission` \"Cross-origin request.\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "scope", "message": "This token is not authorized to read events (requires events:read or events:write scope)." } } } } }, "422": { "description": "A query parameter is not valid. The message names the first bad field by its path. A repeated or unknown query parameter is also a 422.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "validation", "message": "`query`: Invalid input: expected string, received undefined" } } } } }, "429": { "description": "Too many requests. The edge firewall limits each IP to 2000 requests per minute across `/api/v1`; that 429 comes from the edge and can have a body that is not this JSON and no `Retry-After` header. When an edge 429 has no `Retry-After`, retry after 60 seconds. The app also limits each Bearer credential to 600 requests per minute, and some routes limit each user. These limits return this body. This app 429 always has `Retry-After`: retry after that number of seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "rate_limited", "message": "Too many requests." } } } } }, "503": { "description": "A fault on our side. The request is safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "code": "internal", "message": "Something went wrong on our side. Please try again." } } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "conflict", "not_found", "validation", "permission", "scope", "stale", "read_only", "rate_limited", "internal", "batch_rejected", "unauthorized", "checkout_unlinked" ] }, "message": { "type": "string" }, "issues": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "message": { "type": "string" }, "expected": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "feature": { "type": "string" }, "conflictingRows": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "reason": { "type": "string", "enum": [ "changed", "deleted", "newly_present" ] } }, "required": [ "entity", "id", "reason" ], "additionalProperties": false } }, "conflictingRowsTruncated": { "type": "boolean", "const": true }, "usage": { "type": "object", "properties": { "events": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trackers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "calendars": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "projects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "inboxItems", "trackers", "calendars" ], "additionalProperties": false }, "reassignTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "unlinkedCheckout": { "type": "object", "properties": { "sessionId": { "type": "string" }, "paymentReceived": { "type": "boolean" }, "supportUrl": { "type": "string" } }, "required": [ "sessionId", "paymentReceived", "supportUrl" ], "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "The uniform error envelope. `code` is machine-readable, `message` is for a person. `batch_rejected` marks a batch whose ops failed for different reasons." } }, "securitySchemes": { "appSession": { "type": "apiKey", "in": "cookie", "name": "better-auth.session_token", "description": "The signed-in first-party app session (secure deployments use the __Secure- prefix). A public operation also accepts it; a browser request must then come from the same site. `GET /api/v1/me` reports it as `auth.via: \"session\"`." }, "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A Personal Access Token (`Authorization: Bearer rsk_live_…`) or an OAuth 2.1 access token whose resource is `https://reassign.app/api/v1`. Discovery metadata: `/.well-known/oauth-protected-resource/api/v1`." } } } }