{"openapi":"3.1.0","info":{"title":"PlaybookOps API","summary":"Projects, tasks, playbooks, automations, apps and KPIs, for your own tools and AI agents.","description":"Every request acts as the person who made the API key and can only reach what they can see in the app. Send the key as `Authorization: Bearer pbo_live_…`. Errors look like `{\"error\": {\"code\": \"not_found\", \"message\": \"…\"}}`.","version":"1"},"paths":{"/v1/me":{"get":{"tags":["Account"],"summary":"Who am I","description":"The person this key acts as, their organization and role, and what the key may do. Works with any key.","operationId":"whoami","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/people":{"get":{"tags":["People"],"summary":"List people","description":"Active people in the organization with their role, job title, manager and teams. Up to 200; use search to narrow.\n\nNeeds the `people:read` scope.","operationId":"list_people","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Part of a name, job title or team name","title":"Search"},"description":"Part of a name, job title or team name"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/job-roles":{"get":{"tags":["People"],"summary":"List job roles","description":"The organization's job roles (the accountability chart), who holds each and how many responsibilities it has.\n\nNeeds the `people:read` scope.","operationId":"list_job_roles","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRoleList"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/projects":{"get":{"tags":["Projects and items"],"summary":"List projects","description":"Projects you own or are a member of, newest first, with item counts. Templates aren't included.\n\nNeeds the `projects:read` scope.","operationId":"list_projects","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}":{"get":{"tags":["Projects and items"],"summary":"Get a project","description":"One project with its groups (in order) and columns. Item values are keyed by column id.\n\nNeeds the `projects:read` scope.","operationId":"get_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/items":{"get":{"tags":["Projects and items"],"summary":"List a project's items","description":"A project's items in board order, with their custom column values. Filter by group, title or completion; page with offset.\n\nNeeds the `projects:read` scope.","operationId":"list_items","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only items in this group","title":"Group Id"},"description":"Only items in this group"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only items whose title contains this","title":"Search"},"description":"Only items whose title contains this"},{"name":"include_completed","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Completed"}},{"name":"include_subitems","in":"query","required":false,"schema":{"type":"boolean","description":"Also return subitems, each with its parent_id","default":false,"title":"Include Subitems"},"description":"Also return subitems, each with its parent_id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects and items"],"summary":"Create an item","description":"Add an item to a project, optionally in a group, as a subitem, and with column values.\n\nNeeds the `projects:write` scope. This changes real data.","operationId":"create_item","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateItemBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/items/search":{"get":{"tags":["Projects and items"],"summary":"Search items","description":"Find items by title across every project you're on.\n\nNeeds the `projects:read` scope.","operationId":"search_items","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/items/{item_id}":{"get":{"tags":["Projects and items"],"summary":"Get an item","description":"One item (task) with its custom column values, assignee and counts.\n\nNeeds the `projects:read` scope.","operationId":"get_item","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Projects and items"],"summary":"Update an item","description":"Change an item's title, status, assignee, dates, group or column values. Only what you send changes; null clears a field.\n\nNeeds the `projects:write` scope. This changes real data.","operationId":"update_item","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/items/{item_id}/comments":{"get":{"tags":["Projects and items"],"summary":"List an item's updates","description":"The updates (comments) posted on a project item, oldest first.\n\nNeeds the `projects:read` scope.","operationId":"list_item_comments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects and items"],"summary":"Post an update on an item","description":"Post an update (comment) on a project item. Mentioned people are notified like in the app.\n\nNeeds the `projects:write` scope. This changes real data.","operationId":"add_item_comment","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tasks/mine":{"get":{"tags":["Tasks"],"summary":"My tasks","description":"Tasks assigned to you across projects and personal lists, sorted into overdue, due today, upcoming and no due date.\n\nNeeds the `tasks:read` scope.","operationId":"my_tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"include_completed","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Completed"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyTasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/playbooks":{"get":{"tags":["Knowledge"],"summary":"List playbooks","description":"Playbooks you can see, newest first (up to 15), with how many documents each has.\n\nNeeds the `knowledge:read` scope.","operationId":"list_playbooks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Part of a playbook's name or description","title":"Search"},"description":"Part of a playbook's name or description"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaybookList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/content":{"get":{"tags":["Knowledge"],"summary":"Browse content","description":"List or title-search documents, flowcharts, media, uploaded files, courses, projects and workflows you can see. Pass playbook_id to list what's in one playbook.\n\nNeeds the `knowledge:read` scope.","operationId":"list_content","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Part of a title","title":"Search"},"description":"Part of a title"},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"enum":["playbook","document","flowchart","video","audio","image","pdf","word_document","spreadsheet","powerpoint","learning","project","workflow"],"type":"string"}},{"type":"null"}],"description":"Only these kinds of content","title":"Kinds"},"description":"Only these kinds of content"},{"name":"playbook_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only content inside this playbook","title":"Playbook Id"},"description":"Only content inside this playbook"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":30,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/documents/{document_id}":{"get":{"tags":["Knowledge"],"summary":"Read a document","description":"A playbook document as Markdown, with its version, or the text of an uploaded PDF, Word document or PowerPoint. Up to 24,000 characters unless you ask for full=true.\n\nNeeds the `knowledge:read` scope.","operationId":"read_document","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"full","in":"query","required":false,"schema":{"type":"boolean","description":"Return all of a document's Markdown instead of the first 24,000 characters","default":false,"title":"Full"},"description":"Return all of a document's Markdown instead of the first 24,000 characters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Knowledge"],"summary":"Update a document","description":"Change a document's Markdown and details. Send content to replace the whole body, or edits to change part of it: replace_text, replace_section, append, insert or remove_section. Send base_version to avoid overwriting someone else's change.\n\nNeeds the `knowledge:write` scope. This changes real data.","operationId":"update_document","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocumentBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge/search":{"post":{"tags":["Knowledge"],"summary":"Search the knowledge base","description":"Semantic search across the documents and uploaded files you can see. Returns the best passages with their documents. Uses 1 AI credit per search.\n\nNeeds the `knowledge:read` scope.","operationId":"search_knowledge","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/knowledge/who-knows":{"post":{"tags":["Knowledge"],"summary":"Who knows about…","description":"The people to ask about a topic, ranked by the documents they own, review or work from. Uses 1 AI credit.\n\nNeeds the `knowledge:read` scope.","operationId":"who_knows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhoKnowsBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpertList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/automations":{"get":{"tags":["Automations"],"summary":"List automations","description":"Automations you can see: org-wide ones and those in your projects. Pass project_id for one project's.\n\nNeeds the `automations:read` scope.","operationId":"list_automations","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only this project's automations","title":"Project Id"},"description":"Only this project's automations"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/automations/{automation_id}":{"get":{"tags":["Automations"],"summary":"Get an automation","description":"One automation: what starts it, what it does in one sentence, and whether it's on.\n\nNeeds the `automations:read` scope.","operationId":"get_automation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"schema":{"type":"string","title":"Automation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/automations/{automation_id}/runs":{"get":{"tags":["Automations"],"summary":"List an automation's runs","description":"An automation's most recent runs, newest first, with their status and any error.\n\nNeeds the `automations:read` scope.","operationId":"list_automation_runs","security":[{"HTTPBearer":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"schema":{"type":"string","title":"Automation Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Automations"],"summary":"Start an automation","description":"Start an automation that's started by hand (its trigger is Manual). Returns the run; poll get_automation_run for progress.\n\nNeeds the `automations:write` scope. This changes real data.","operationId":"start_automation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"schema":{"type":"string","title":"Automation Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/automation-runs/{run_id}":{"get":{"tags":["Automations"],"summary":"Get a run","description":"One run with each step it took, in order, and where it stopped or failed.\n\nNeeds the `automations:read` scope.","operationId":"get_automation_run","security":[{"HTTPBearer":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/apps":{"get":{"tags":["Apps"],"summary":"List apps","description":"Published apps built in PlaybookOps that you can open.\n\nNeeds the `apps:read` scope.","operationId":"list_apps","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppList"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/apps/{app_id}":{"get":{"tags":["Apps"],"summary":"Get an app","description":"One app with its collections (tables) and their fields, so you know what to ask for.\n\nNeeds the `apps:read` scope.","operationId":"get_app","security":[{"HTTPBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/apps/{app_id}/collections/{collection}/records/{record_id}":{"get":{"tags":["Apps"],"summary":"Get an app record","description":"One Live record from an app's collection.\n\nNeeds the `apps:read` scope.","operationId":"get_app_record","security":[{"HTTPBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","title":"App Id"}},{"name":"collection","in":"path","required":true,"schema":{"type":"string","title":"Collection"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","title":"Record Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Apps"],"summary":"Update an app record","description":"Change some fields on a Live app record. Fields you leave out stay as they are.\n\nNeeds the `apps:write` scope. This changes real data.","operationId":"update_app_record","security":[{"HTTPBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","title":"App Id"}},{"name":"collection","in":"path","required":true,"schema":{"type":"string","title":"Collection"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","title":"Record Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRecordBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kpis":{"get":{"tags":["KPIs"],"summary":"List KPIs","description":"Active KPIs on the scorecard that you can see, with their goal, owner and team.\n\nNeeds the `kpis:read` scope.","operationId":"list_kpis","security":[{"HTTPBearer":[]}],"parameters":[{"name":"team_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A team's KPIs plus the org-wide ones","title":"Team Id"},"description":"A team's KPIs plus the org-wide ones"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpiList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kpis/{kpi_id}/values":{"get":{"tags":["KPIs"],"summary":"Get a KPI's values","description":"A KPI's recorded values by period, oldest first.\n\nNeeds the `kpis:read` scope.","operationId":"get_kpi_values","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kpi_id","in":"path","required":true,"schema":{"type":"string","title":"Kpi Id"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Periods starting on or after this day","title":"Since"},"description":"Periods starting on or after this day"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Periods starting on or before this day","title":"Until"},"description":"Periods starting on or before this day"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpiValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/items/{item_id}/move":{"post":{"tags":["Projects and items"],"summary":"Move an item to another project","description":"Move an item and its subitems to another project you can edit. Column values move to columns with the same name and type.\n\nNeeds the `projects:write` scope. This changes real data.","operationId":"move_item","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveItemBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/items/{item_id}/complete":{"post":{"tags":["Projects and items"],"summary":"Complete an item","description":"Mark a project item done, or reopen it with completed=false.\n\nNeeds the `projects:write` scope. This changes real data.","operationId":"complete_item","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/playbooks/{playbook_id}/documents":{"post":{"tags":["Knowledge"],"summary":"Create a document","description":"Add a document to a playbook, written in Markdown. Returns it with its id and version.\n\nNeeds the `knowledge:write` scope. This changes real data.","operationId":"create_document","security":[{"HTTPBearer":[]}],"parameters":[{"name":"playbook_id","in":"path","required":true,"schema":{"type":"string","title":"Playbook Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tasks":{"post":{"tags":["Tasks"],"summary":"Create a task","description":"Add a task outside any project, for you or a teammate. It shows in their My tasks.\n\nNeeds the `tasks:write` scope. This changes real data.","operationId":"create_task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaskBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tasks/{task_id}":{"patch":{"tags":["Tasks"],"summary":"Update a task","description":"Change one of your tasks: a personal task, or a project item assigned to you. Only what you send changes; null clears a field.\n\nNeeds the `tasks:write` scope. This changes real data.","operationId":"update_task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tasks/{task_id}/complete":{"post":{"tags":["Tasks"],"summary":"Complete a task","description":"Mark one of your tasks done, or reopen it with completed=false.\n\nNeeds the `tasks:write` scope. This changes real data.","operationId":"complete_task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteTaskBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/apps/{app_id}/collections/{collection}/records":{"post":{"tags":["Apps"],"summary":"Create an app record","description":"Add a Live record to one of an app's collections. Fields are checked against the app like in the app itself.\n\nNeeds the `apps:write` scope. This changes real data.","operationId":"create_app_record","security":[{"HTTPBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","title":"App Id"}},{"name":"collection","in":"path","required":true,"schema":{"type":"string","title":"Collection"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key.","title":"Idempotency-Key"},"description":"Any unique string, like a UUID. Retrying with the same key returns the first answer instead of making the change again. Keys are kept per API key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRecordBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Apps"],"summary":"List an app's records","description":"Live records in one of an app's collections. Filter by field (eq, neq, gt, lt, in, contains, has), sort, and page with offset.\n\nNeeds the `apps:read` scope.","operationId":"list_app_records","security":[{"HTTPBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","title":"App Id"}},{"name":"collection","in":"path","required":true,"schema":{"type":"string","title":"Collection"}},{"name":"filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Repeat for each filter, as field:op:value, like status:eq:open or amount:gt:100. Ops: eq, neq, gt, lt, in, contains, has.","default":[],"title":"Filter"},"description":"Repeat for each filter, as field:op:value, like status:eq:open or amount:gt:100. Ops: eq, neq, gt, lt, in, contains, has."},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A field to sort by; start it with - for largest or latest first","title":"Sort"},"description":"A field to sort by; start it with - for largest or latest first"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRecordList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"App":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","name","url"],"title":"App"},"AppCollection":{"properties":{"name":{"type":"string","title":"Name"},"display_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Field","description":"The field that names a record wherever it's linked"},"fields":{"items":{"$ref":"#/components/schemas/AppField"},"type":"array","title":"Fields"}},"type":"object","required":["name","fields"],"title":"AppCollection"},"AppDetail":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"url":{"type":"string","title":"Url"},"collections":{"items":{"$ref":"#/components/schemas/AppCollection"},"type":"array","title":"Collections"}},"type":"object","required":["id","name","url","collections"],"title":"AppDetail"},"AppField":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"required":{"type":"boolean","title":"Required","default":false},"options":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Options"},"links_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Links To","description":"For a reference field, the collection it points at"},"many":{"type":"boolean","title":"Many","default":false}},"type":"object","required":["name","type"],"title":"AppField"},"AppList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/App"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"AppList"},"AppRecord":{"properties":{"id":{"type":"string","title":"Id"},"collection":{"type":"string","title":"Collection"},"data":{"additionalProperties":true,"type":"object","title":"Data"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","collection","data"],"title":"AppRecord"},"AppRecordList":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"More results after these; ask again with offset=next_offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"data":{"items":{"$ref":"#/components/schemas/AppRecord"},"type":"array","title":"Data"}},"type":"object","required":["has_more","data"],"title":"AppRecordList"},"Append":{"properties":{"op":{"type":"string","const":"append","title":"Op"},"markdown":{"type":"string","minLength":1,"title":"Markdown","description":"Markdown to put there"},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section","description":"Leave out for the end of the document. A heading's text, like Steps or ## Steps. If two headings share a name, give the path, like Onboarding > Steps."}},"type":"object","required":["op","markdown"],"title":"Append","description":"Add to the end of the document, or to the end of one section."},"Automation":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"project_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Title"},"app_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Id"},"is_on":{"type":"boolean","title":"Is On"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trigger","description":"What starts it, in words"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"The whole automation as one sentence"},"startable":{"type":"boolean","title":"Startable","description":"Published, on and started by hand"},"needs_item":{"type":"boolean","title":"Needs Item","default":false},"published_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Published Version"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","title","is_on","startable","url"],"title":"Automation"},"AutomationList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Automation"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"AutomationList"},"AutomationRun":{"properties":{"id":{"type":"string","title":"Id"},"automation_id":{"type":"string","title":"Automation Id"},"automation_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Automation Title"},"status":{"type":"string","title":"Status"},"trigger_type":{"type":"string","title":"Trigger Type"},"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id"},"item_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Title"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Id"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"is_test":{"type":"boolean","title":"Is Test","default":false},"started_at":{"type":"string","format":"date-time","title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","required":["id","automation_id","status","trigger_type","started_at"],"title":"AutomationRun"},"AutomationRunDetail":{"properties":{"id":{"type":"string","title":"Id"},"automation_id":{"type":"string","title":"Automation Id"},"automation_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Automation Title"},"status":{"type":"string","title":"Status"},"trigger_type":{"type":"string","title":"Trigger Type"},"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id"},"item_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Title"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Id"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"is_test":{"type":"boolean","title":"Is Test","default":false},"started_at":{"type":"string","format":"date-time","title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"steps":{"items":{"$ref":"#/components/schemas/RunStep"},"type":"array","title":"Steps"}},"type":"object","required":["id","automation_id","status","trigger_type","started_at","steps"],"title":"AutomationRunDetail"},"AutomationRunList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AutomationRun"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"AutomationRunList"},"Column":{"properties":{"id":{"type":"string","title":"Id","description":"Column id, or \"system:<key>\" for built-in columns. Item values are keyed by this id."},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"is_built_in":{"type":"boolean","title":"Is Built In"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"options":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Options","description":"Labels of a status or dropdown column: id, label, color","default":[]}},"type":"object","required":["id","key","name","type","is_built_in"],"title":"Column"},"Comment":{"properties":{"id":{"type":"string","title":"Id"},"author_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Id"},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name"},"body":{"type":"string","title":"Body"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","body","created_at"],"title":"Comment"},"CommentBody":{"properties":{"body":{"type":"string","maxLength":20000,"minLength":1,"title":"Body","description":"Plain text or Markdown. Mention people as [@Name](mention://user/<id>)."}},"type":"object","required":["body"],"title":"CommentBody"},"CommentList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Comment"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"CommentList"},"CompleteBody":{"properties":{"completed":{"type":"boolean","title":"Completed","description":"false reopens it","default":true},"note":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Note"}},"type":"object","title":"CompleteBody"},"CompleteTaskBody":{"properties":{"completed":{"type":"boolean","title":"Completed","description":"false reopens it","default":true},"note":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Note"}},"type":"object","title":"CompleteTaskBody"},"ContentItem":{"properties":{"id":{"type":"string","title":"Id"},"kind":{"type":"string","title":"Kind","description":"document, flowchart, video, pdf, project, workflow and so on"},"title":{"type":"string","title":"Title"},"playbook_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Playbook Id"},"playbook_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Playbook Name"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","required":["id","kind","title"],"title":"ContentItem"},"ContentList":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"More results after these; ask again with offset=next_offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"data":{"items":{"$ref":"#/components/schemas/ContentItem"},"type":"array","title":"Data"}},"type":"object","required":["has_more","data"],"title":"ContentList"},"CreateDocumentBody":{"properties":{"title":{"type":"string","maxLength":300,"minLength":1,"title":"Title"},"content":{"type":"string","maxLength":500000,"title":"Content","description":"The body as Markdown: headings, lists, checklists, tables, code, callouts (:::note), toggles (<details>), images and @mentions. See the Markdown guide in the docs.","default":""},"description":{"type":"string","maxLength":2000,"title":"Description","description":"A one-line summary shown in lists","default":""},"document_type":{"type":"string","enum":["sop","process","training","policy","procedure","manual","workflow","internal_document","job_description","project_plan","general","proven_process"],"title":"Document Type","description":"What kind of document it is. It can't change later.","default":"general"},"status":{"type":"string","enum":["draft","published"],"title":"Status","description":"Shown on the document in the app. It doesn't change who can see it.","default":"draft"},"tags":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Tags"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"A folder in this playbook; leave out for the top level"}},"type":"object","required":["title"],"title":"CreateDocumentBody"},"CreateItemBody":{"properties":{"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Status"},"priority":{"anyOf":[{"$ref":"#/components/schemas/TaskPriority"},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id","description":"A person's id from list_people; null unassigns"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"null removes the due date"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"Defaults to the project's first group"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Make it a subitem of this item"},"values":{"additionalProperties":true,"type":"object","title":"Values","description":"Column id (or key) to its new value; null clears it. Get a project's columns from get_project."}},"type":"object","required":["title"],"title":"CreateItemBody"},"CreateRecordBody":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The record's fields by name, as listed by get_app. Fields starting with _ are reserved."}},"type":"object","required":["data"],"title":"CreateRecordBody"},"CreateTaskBody":{"properties":{"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Status"},"priority":{"anyOf":[{"$ref":"#/components/schemas/TaskPriority"},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id","description":"A person's id from list_people; defaults to you"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"null removes the due date"}},"type":"object","required":["title"],"title":"CreateTaskBody"},"Document":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"kind":{"type":"string","title":"Kind"},"content":{"type":"string","title":"Content","description":"Markdown for documents; extracted text for uploaded files"},"truncated":{"type":"boolean","title":"Truncated","description":"The content was cut short. Ask for full=true to get all of a document."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"Documents only. Send it back as base_version when you change the document."},"status":{"anyOf":[{"type":"string","enum":["draft","published","archived"]},{"type":"null"}],"title":"Status"},"playbook_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Playbook Id"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","required":["id","title","kind","content","truncated"],"title":"Document"},"Expert":{"properties":{"name":{"type":"string","title":"Name"},"why":{"items":{"type":"string"},"type":"array","title":"Why","description":"Why they know, like \"owns Refund policy\""}},"type":"object","required":["name","why"],"title":"Expert"},"ExpertList":{"properties":{"topic":{"type":"string","title":"Topic"},"data":{"items":{"$ref":"#/components/schemas/Expert"},"type":"array","title":"Data"},"credits_used":{"type":"integer","title":"Credits Used"}},"type":"object","required":["topic","data","credits_used"],"title":"ExpertList"},"Group":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"position":{"type":"integer","title":"Position"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","position"],"title":"Group"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Insert":{"properties":{"op":{"type":"string","const":"insert","title":"Op"},"markdown":{"type":"string","minLength":1,"title":"Markdown","description":"Markdown to put there"},"before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before","description":"A heading's text, like Steps or ## Steps. If two headings share a name, give the path, like Onboarding > Steps."},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"A heading's text, like Steps or ## Steps. If two headings share a name, give the path, like Onboarding > Steps."}},"type":"object","required":["op","markdown"],"title":"Insert","description":"Add blocks just before a section's heading, or just after the section ends."},"Item":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"project_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Title"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id"},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name"},"status":{"type":"string","title":"Status"},"priority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Priority"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"is_completed":{"type":"boolean","title":"Is Completed"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id"},"assignee_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Name"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"values":{"additionalProperties":true,"type":"object","title":"Values","description":"Custom column values, keyed by column id","default":{}},"subitem_count":{"type":"integer","title":"Subitem Count","default":0},"comment_count":{"type":"integer","title":"Comment Count","default":0},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","title","status","is_completed","url"],"title":"Item"},"ItemList":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"More results after these; ask again with offset=next_offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"data":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"Data"}},"type":"object","required":["has_more","data"],"title":"ItemList"},"JobRole":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"holders":{"items":{"type":"string"},"type":"array","title":"Holders","description":"Names of the people in this role","default":[]},"responsibility_count":{"type":"integer","title":"Responsibility Count","default":0}},"type":"object","required":["id","name"],"title":"JobRole"},"JobRoleList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/JobRole"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"JobRoleList"},"Kpi":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"unit":{"type":"string","title":"Unit","description":"number, currency, percent and so on"},"frequency":{"type":"string","title":"Frequency","description":"weekly, monthly or quarterly"},"goal":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Goal"},"goal_direction":{"type":"string","title":"Goal Direction","description":"above or below: which side of the goal is on track"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name","description":"The person or job role that owns it"},"team_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Name","description":"Empty for org-wide KPIs"}},"type":"object","required":["id","name","unit","frequency","goal_direction"],"title":"Kpi"},"KpiList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Kpi"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"KpiList"},"KpiValue":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["period_start"],"title":"KpiValue"},"KpiValues":{"properties":{"kpi_id":{"type":"string","title":"Kpi Id"},"data":{"items":{"$ref":"#/components/schemas/KpiValue"},"type":"array","title":"Data"}},"type":"object","required":["kpi_id","data"],"title":"KpiValues"},"Me":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"organization_id":{"type":"string","title":"Organization Id"},"role":{"type":"string","title":"Role"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"via":{"type":"string","const":"api_key","title":"Via","default":"api_key"}},"type":"object","required":["id","organization_id","role","scopes"],"title":"Me"},"MoveItemBody":{"properties":{"project_id":{"type":"string","title":"Project Id","description":"The project to move it to"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"A group in that project; defaults to its first group"}},"type":"object","required":["project_id"],"title":"MoveItemBody"},"MyTasks":{"properties":{"overdue":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"Overdue"},"due_today":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"Due Today"},"upcoming":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"Upcoming"},"no_due_date":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"No Due Date"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["overdue","due_today","upcoming","no_due_date","total"],"title":"MyTasks"},"Person":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title"},"role":{"type":"string","title":"Role","description":"global_admin, org_admin, member or viewer"},"manager_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Name"},"teams":{"items":{"type":"string"},"type":"array","title":"Teams","default":[]}},"type":"object","required":["id","role"],"title":"Person"},"PersonList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Person"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"PersonList"},"Playbook":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"document_count":{"type":"integer","title":"Document Count","default":0},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","name","url"],"title":"Playbook"},"PlaybookList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Playbook"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"PlaybookList"},"Project":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","title":"Status"},"owner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Id"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"},"item_count":{"type":"integer","title":"Item Count","default":0},"completed_item_count":{"type":"integer","title":"Completed Item Count","default":0},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"},"target_end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Target End Date"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","title","status","url"],"title":"Project"},"ProjectDetail":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","title":"Status"},"owner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Id"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"},"item_count":{"type":"integer","title":"Item Count","default":0},"completed_item_count":{"type":"integer","title":"Completed Item Count","default":0},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"},"target_end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Target End Date"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"url":{"type":"string","title":"Url"},"groups":{"items":{"$ref":"#/components/schemas/Group"},"type":"array","title":"Groups"},"columns":{"items":{"$ref":"#/components/schemas/Column"},"type":"array","title":"Columns"},"your_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Your Role","description":"viewer, editor or admin on this project"}},"type":"object","required":["id","title","status","url","groups","columns"],"title":"ProjectDetail"},"ProjectList":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"More results after these; ask again with offset=next_offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"data":{"items":{"$ref":"#/components/schemas/Project"},"type":"array","title":"Data"}},"type":"object","required":["has_more","data"],"title":"ProjectList"},"RemoveSection":{"properties":{"op":{"type":"string","const":"remove_section","title":"Op"},"section":{"type":"string","minLength":1,"title":"Section","description":"A heading's text, like Steps or ## Steps. If two headings share a name, give the path, like Onboarding > Steps."}},"type":"object","required":["op","section"],"title":"RemoveSection","description":"Delete a heading and everything under it."},"ReplaceSection":{"properties":{"op":{"type":"string","const":"replace_section","title":"Op"},"section":{"type":"string","minLength":1,"title":"Section","description":"A heading's text, like Steps or ## Steps. If two headings share a name, give the path, like Onboarding > Steps."},"markdown":{"type":"string","title":"Markdown","description":"Markdown to put there"}},"type":"object","required":["op","section","markdown"],"title":"ReplaceSection","description":"Replace everything under a heading, subsections included. The heading stays."},"ReplaceText":{"properties":{"op":{"type":"string","const":"replace_text","title":"Op"},"find":{"type":"string","minLength":1,"title":"Find","description":"Exact text to find, including Markdown"},"replace":{"type":"string","title":"Replace","description":"What to put instead; empty deletes it"},"all":{"type":"boolean","title":"All","description":"Replace every match instead of requiring exactly one","default":false}},"type":"object","required":["op","find","replace"],"title":"ReplaceText","description":"Swap exact text. It must appear once, unless all is true."},"RunStep":{"properties":{"node_id":{"type":"string","title":"Node Id"},"type":{"type":"string","title":"Type"},"status":{"type":"string","title":"Status"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","required":["node_id","type","status"],"title":"RunStep"},"SearchBody":{"properties":{"query":{"type":"string","maxLength":500,"minLength":2,"title":"Query","description":"A question or topic, in plain words"}},"type":"object","required":["query"],"title":"SearchBody"},"SearchHit":{"properties":{"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Id"},"title":{"type":"string","title":"Title"},"passage":{"type":"string","title":"Passage"},"similarity":{"type":"number","title":"Similarity"},"playbook_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Playbook Name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","required":["title","passage","similarity"],"title":"SearchHit"},"SearchResults":{"properties":{"query":{"type":"string","title":"Query"},"data":{"items":{"$ref":"#/components/schemas/SearchHit"},"type":"array","title":"Data"},"credits_used":{"type":"integer","title":"Credits Used"}},"type":"object","required":["query","data","credits_used"],"title":"SearchResults"},"StartBody":{"properties":{"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id","description":"The item to run it on, when the automation needs one"},"record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Id","description":"For an app's automation: the Live record to run it on, when it needs one"}},"type":"object","title":"StartBody"},"TaskPriority":{"type":"string","enum":["low","medium","high","urgent"],"title":"TaskPriority","description":"Priority levels for tasks"},"UpdateDocumentBody":{"properties":{"base_version":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Base Version","description":"The version you read. If someone changed the document since, nothing changes and you get a 409."},"content":{"anyOf":[{"type":"string","maxLength":500000,"minLength":1},{"type":"null"}],"title":"Content","description":"Replace the whole body with this Markdown"},"edits":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/ReplaceText"},{"$ref":"#/components/schemas/ReplaceSection"},{"$ref":"#/components/schemas/Append"},{"$ref":"#/components/schemas/Insert"},{"$ref":"#/components/schemas/RemoveSection"}],"discriminator":{"propertyName":"op","mapping":{"append":"#/components/schemas/Append","insert":"#/components/schemas/Insert","remove_section":"#/components/schemas/RemoveSection","replace_section":"#/components/schemas/ReplaceSection","replace_text":"#/components/schemas/ReplaceText"}}},"type":"array","maxItems":50,"minItems":1},{"type":"null"}],"title":"Edits","description":"Precise changes, applied in order; all of them apply or none do. Each has an op: replace_text, replace_section, append, insert or remove_section. Don't send with content."},"title":{"anyOf":[{"type":"string","maxLength":300,"minLength":1},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"type":"string","enum":["draft","published","archived"]},{"type":"null"}],"title":"Status","description":"Only the document's owner can change this. Archived documents drop out of title search."},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":20},{"type":"null"}],"title":"Tags","description":"Replaces all of the document's tags"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"Move it to this folder in the same playbook; null moves it to the top level"}},"type":"object","title":"UpdateDocumentBody"},"UpdateItemBody":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Status"},"priority":{"anyOf":[{"$ref":"#/components/schemas/TaskPriority"},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id","description":"A person's id from list_people; null unassigns"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"null removes the due date"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"Move it to another group in the same project"},"values":{"additionalProperties":true,"type":"object","title":"Values","description":"Column id (or key) to its new value; null clears it. Get a project's columns from get_project."}},"type":"object","title":"UpdateItemBody"},"UpdateRecordBody":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data","description":"Only the fields to change; null clears one. The record's fields by name, as listed by get_app. Fields starting with _ are reserved."}},"type":"object","required":["data"],"title":"UpdateRecordBody"},"UpdateTaskBody":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Status"},"priority":{"anyOf":[{"$ref":"#/components/schemas/TaskPriority"},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id","description":"A person's id from list_people; null unassigns"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"null removes the due date"}},"type":"object","title":"UpdateTaskBody"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WhoKnowsBody":{"properties":{"topic":{"type":"string","maxLength":500,"minLength":2,"title":"Topic"}},"type":"object","required":["topic"],"title":"WhoKnowsBody"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"An API key from Account → API keys, sent as `Authorization: Bearer pbo_live_…`","scheme":"bearer"}}},"servers":[{"url":"https://developers-dev.playbookops.ai"}]}