{"openapi":"3.1.0","info":{"title":"Shortcut Objectives (BYOK) API","version":"0.1.0","description":"Shortcut Objectives (BYOK) lets an AI assistant read your own Shortcut Objectives data through the Shortcut Objectives API with a key you supply (Shortcut API token). Read-only: 12 tools (list_objectives, get_objective, list_objective_epics, get_objective_health, list_objective_health_history, get_key_result, list_categories, list_category_objectives, get_epic_health, list_epic_health_history,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shortcut-objectives.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shortcut-objectives/docs"},"termsOfService":"https://connectorbay.com/byok-shortcut-objectives/terms"},"servers":[{"url":"https://byok-shortcut-objectives.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shortcut-objectives/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_objectives":{"post":{"operationId":"list_objectives","summary":"List Shortcut objectives (goals above epics) with state, dates, categories, key result ids and cycle and lead time stati","description":"List Shortcut objectives (goals above epics) with state, dates, categories, key result ids and cycle and lead time statistics. Use for \"What objectives does our Shortcut workspace have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_objectivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_objective":{"post":{"operationId":"get_objective","summary":"Get one Shortcut objective: state, dates, categories, key result ids and statistics. Use for \"Show Shortcut objective 12","description":"Get one Shortcut objective: state, dates, categories, key result ids and statistics. Use for \"Show Shortcut objective 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"objective_id":{"description":"Numeric Shortcut objective id, for example 12 (see list_objectives).","minimum":1,"title":"Objective Id","type":"integer"}},"required":["objective_id"],"title":"get_objectiveArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_objective_epics":{"post":{"operationId":"list_objective_epics","summary":"List the epics that contribute to an objective with state, dates, owners, milestone and link. Use for \"Which epics belon","description":"List the epics that contribute to an objective with state, dates, owners, milestone and link. Use for \"Which epics belong to Shortcut objective 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"objective_id":{"description":"Numeric Shortcut objective id, for example 12 (see list_objectives).","minimum":1,"title":"Objective Id","type":"integer"}},"required":["objective_id"],"title":"list_objective_epicsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_objective_health":{"post":{"operationId":"get_objective_health","summary":"Get the current health update of an objective: status (On Track, At Risk, Off Track), note, author and time. Use for \"Ho","description":"Get the current health update of an objective: status (On Track, At Risk, Off Track), note, author and time. Use for \"How healthy is Shortcut objective 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"objective_id":{"description":"Numeric Shortcut objective id, for example 12 (see list_objectives).","minimum":1,"title":"Objective Id","type":"integer"}},"required":["objective_id"],"title":"get_objective_healthArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_objective_health_history":{"post":{"operationId":"list_objective_health_history","summary":"List the past health updates of an objective, with status, note, author and time. Use for \"How has the health of Shortcu","description":"List the past health updates of an objective, with status, note, author and time. Use for \"How has the health of Shortcut objective 12 changed over time\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"objective_id":{"description":"Numeric Shortcut objective id, for example 12 (see list_objectives).","minimum":1,"title":"Objective Id","type":"integer"}},"required":["objective_id"],"title":"list_objective_health_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_key_result":{"post":{"operationId":"get_key_result","summary":"Get one key result: name, type, objective, initial, current and target values and progress. Use for \"Show Shortcut key r","description":"Get one key result: name, type, objective, initial, current and target values and progress. Use for \"Show Shortcut key result 0000aaaa-0000-4000-8000-000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"key_result_id":{"description":"Key result id (a UUID from an objective's key_result_ids).","maxLength":60,"title":"Key Result Id","type":"string"}},"required":["key_result_id"],"title":"get_key_resultArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_categories":{"post":{"operationId":"list_categories","summary":"List Shortcut categories used to tag objectives and milestones, with color and archived flag. Use for \"Which categories ","description":"List Shortcut categories used to tag objectives and milestones, with color and archived flag. Use for \"Which categories exist in Shortcut\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_categoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_category_objectives":{"post":{"operationId":"list_category_objectives","summary":"List the objectives tagged with a category. Use for \"Which Shortcut objectives are in category 3\".","description":"List the objectives tagged with a category. Use for \"Which Shortcut objectives are in category 3\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"category_id":{"description":"Numeric Shortcut category id, for example 3 (see list_categories).","minimum":1,"title":"Category Id","type":"integer"}},"required":["category_id"],"title":"list_category_objectivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_epic_health":{"post":{"operationId":"get_epic_health","summary":"Get the current health update of an epic: status, note, author and time. Use for \"How healthy is Shortcut epic 45\".","description":"Get the current health update of an epic: status, note, author and time. Use for \"How healthy is Shortcut epic 45\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"epic_id":{"description":"Numeric Shortcut epic id, for example 45.","minimum":1,"title":"Epic Id","type":"integer"}},"required":["epic_id"],"title":"get_epic_healthArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_epic_health_history":{"post":{"operationId":"list_epic_health_history","summary":"List the past health updates of an epic, with status, note, author and time. Use for \"How has the health of Shortcut epi","description":"List the past health updates of an epic, with status, note, author and time. Use for \"How has the health of Shortcut epic 45 changed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"epic_id":{"description":"Numeric Shortcut epic id, for example 45.","minimum":1,"title":"Epic Id","type":"integer"}},"required":["epic_id"],"title":"list_epic_health_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_epic_workflow":{"post":{"operationId":"get_epic_workflow","summary":"Get the epic workflow: the default epic state id and every epic state (To Do, In Progress, Done ...) with type and posit","description":"Get the epic workflow: the default epic state id and every epic state (To Do, In Progress, Done ...) with type and position. Use for \"What states can a Shortcut epic be in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_epic_workflowArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_milestones":{"post":{"operationId":"list_milestones","summary":"List Shortcut milestones (the older name for objectives, still returned) with state, dates and categories. Use for \"What","description":"List Shortcut milestones (the older name for objectives, still returned) with state, dates and categories. Use for \"What milestones does Shortcut have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_milestonesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}