{"openapi":"3.1.0","info":{"title":"Melonforce API","version":"v1","description":"Read and write your workspace's boards, columns, views, groups, items, notes and updates, and follow their changes. Send an API key as a bearer token. Guides: https://melonforce.com/docs"},"servers":[{"url":"https://api.melonforce.com"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"boards","description":"The boards in the key's workspace."},{"name":"columns","description":"A board's columns: their types, settings and order."},{"name":"views","description":"A board's saved views: a filter, sort and Group by with a name."},{"name":"groups","description":"A board's groups: the named, colored sections that hold its items, in the board's order."},{"name":"items","description":"A board's items: create, batch, list, query, read, update, move, archive, delete and restore."},{"name":"notes","description":"An item's notes."},{"name":"updates","description":"An item's updates: comments and posts, and its feed."},{"name":"changes","description":"What changed on a board or an item, in order, for following it."},{"name":"members","description":"The workspace's members, for setting a person column."}],"paths":{"/v1/boards":{"get":{"operationId":"boards.list","tags":["boards"],"summary":"List boards","description":"The workspace's live boards, oldest first. Each entry is a summary: read a board for its columns and views.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"boards":{"type":"array","items":{"$ref":"#/components/schemas/BoardSummary"},"description":"The workspace's live boards, oldest first. Deleted boards are left out."}},"required":["boards"]},"example":{"boards":[{"id":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","itemWord":"move","createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"},{"id":"brd_5t1r8e3w6q9y2u4i7o0pa","name":"Trucks","itemWord":"truck","createdAt":"2026-11-18T10:12:00.000Z","updatedAt":"2026-11-18T10:12:00.000Z"}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"post":{"operationId":"boards.create","tags":["boards"],"summary":"Create a board","description":"Creates a board with the columns you send, in that order, one Table view named \"Table\" and one group named after the board. An indexed column (status, person or date) you leave out goes to the first column in `columns` that fits it; one you name stays as named, `null` included. A column ID used twice answers 409 `COLUMN_ID_TAKEN`. Send an `Idempotency-Key` so a retry cannot create a second board.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same key again within 24 hours to get the first answer back instead of writing twice. 1 to 128 printable characters, with no spaces.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,128}$"},"example":"7b1e9d3c-moves-board-create-1118"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60,"description":"The board's name, 1 to 60 characters, trimmed."},"itemWord":{"default":"item","description":"What one item is called, 1 to 24 characters. Defaults to `item`.","type":"string","minLength":1,"maxLength":24},"columns":{"description":"The columns after Name, in order, up to 60. Column IDs must be unique. Left out, the board has only Name.","maxItems":60,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"text","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"long_text","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"number","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsNumberInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"status","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsStatusInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"dropdown","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsDropdownInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"person","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsPersonInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"date","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsDateInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"link","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"phone","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsPhoneInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"email","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"button","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Required for this type.","$ref":"#/components/schemas/ColumnSettingsButton"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type","settings"],"additionalProperties":false}],"description":"A new column. `type` decides which `settings` it takes."}},"mainStatusColumnId":{"description":"The indexed status column: the ID of a status column in `columns`, or null for none. Left out, the first status column takes it.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"mainPersonColumnId":{"description":"The indexed person column: the ID of a person column in `columns` that holds one person, or null for none. Left out, the first such column takes it.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"mainDateColumnId":{"description":"The indexed date column: the ID of a date column in `columns`, or null for none. Left out, the first date column takes it.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"claimEnabled":{"description":"Whether members may Claim items. Defaults to false.","type":"boolean"}},"required":["name"],"additionalProperties":false},"example":{"name":"Moves","itemWord":"move","columns":[{"id":"status","name":"Status","type":"status","settings":{"labels":[{"name":"Booked","color":"blue"},{"name":"Packing","color":"amber"},{"name":"Moved","color":"teal"}]}},{"id":"move_date","name":"Move date","type":"date"},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day."}]}}}},"responses":{"201":{"description":"The new board. A replay of a create first answered before boards had groups can lack `groups`: read the board for them.","content":{"application/json":{"schema":{"type":"object","properties":{"board":{"description":"The board.","$ref":"#/components/schemas/Board"}},"required":["board"]},"example":{"board":{"id":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","itemWord":"move","mainStatusColumnId":"status","mainPersonColumnId":"crew_lead","mainDateColumnId":"move_date","claimEnabled":false,"createdAt":"2026-11-18T09:30:00.000Z","createdBy":"apk_7d4f2g9h1j6k3l8z5x0cv","updatedAt":"2026-11-18T09:30:00.000Z","columns":[{"id":"name","name":"Name","type":"name","description":null,"settings":{},"position":0},{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"}]},"position":1},{"id":"move_date","name":"Move date","type":"date","description":null,"settings":{"includeTime":false},"position":2},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day.","settings":{"multiple":false},"position":3}],"views":[{"id":"viw_3h7j1k9m2n4p6q8r0s5tx","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Table","type":"table","position":0,"config":{"filter":null,"sort":[],"group":null,"statusColumnId":null,"columns":[],"openIn":"panel"},"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"groups":[{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":0,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"itemCount":0}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"409":{"description":"- `COLUMN_ID_TAKEN`: The column ID is already used on the board, by a deleted column too. Choose another.\n- `COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.\n- `IDEMPOTENCY_KEY_REUSED`: The `Idempotency-Key` was used before with a different request, or a request with the same key is still running. In the second case, send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `IDEMPOTENCY_KEY_REUSED`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"COLUMN_ID_TAKEN":{"value":{"error":{"code":"COLUMN_ID_TAKEN"}}},"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}},"IDEMPOTENCY_KEY_REUSED":{"value":{"error":{"code":"IDEMPOTENCY_KEY_REUSED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}":{"get":{"operationId":"boards.get","tags":["boards"],"summary":"Get a board","description":"The board with its columns (Name first), its views in tab order, its groups in order and its count of live items. A deleted board answers 404.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"board":{"description":"The board.","$ref":"#/components/schemas/Board"}},"required":["board"]},"example":{"board":{"id":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","itemWord":"move","mainStatusColumnId":"status","mainPersonColumnId":"crew_lead","mainDateColumnId":"move_date","claimEnabled":false,"createdAt":"2026-11-18T09:30:00.000Z","createdBy":"apk_7d4f2g9h1j6k3l8z5x0cv","updatedAt":"2026-11-18T09:30:00.000Z","columns":[{"id":"name","name":"Name","type":"name","description":null,"settings":{},"position":0},{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"}]},"position":1},{"id":"move_date","name":"Move date","type":"date","description":null,"settings":{"includeTime":false},"position":2},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day.","settings":{"multiple":false},"position":3}],"views":[{"id":"viw_3h7j1k9m2n4p6q8r0s5tx","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Table","type":"table","position":0,"config":{"filter":null,"sort":[],"group":null,"statusColumnId":null,"columns":[],"openIn":"panel"},"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"groups":[{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"In storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:31:12.550Z"},{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":1,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"itemCount":4}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"patch":{"operationId":"boards.update","tags":["boards"],"summary":"Update a board","description":"Changes the name, the item word, the Claim setting or the indexed columns; send only the fields to change. A different indexed column rewrites that field's copy on every item. A request that changes nothing answers 200 and writes nothing. When others change the board at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name, 1 to 60 characters.","type":"string","minLength":1,"maxLength":60},"itemWord":{"description":"What one item is called, 1 to 24 characters.","type":"string","minLength":1,"maxLength":24},"mainStatusColumnId":{"description":"A status column of the board to be the indexed one, or null for none. A different one rewrites every item's copy.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"mainPersonColumnId":{"description":"A person column of the board that holds one person, to be the indexed one (the column Claim fills), or null for none. A different one rewrites every item's copy.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"mainDateColumnId":{"description":"A date column of the board to be the indexed one, or null for none. A different one rewrites every item's copy.","anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}]},"claimEnabled":{"description":"Whether members may Claim items.","type":"boolean"}},"additionalProperties":false,"description":"The fields to change. Send at least one."},"example":{"name":"Local moves"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"board":{"description":"The board.","$ref":"#/components/schemas/Board"}},"required":["board"]},"example":{"board":{"id":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Local moves","itemWord":"move","mainStatusColumnId":"status","mainPersonColumnId":"crew_lead","mainDateColumnId":"move_date","claimEnabled":false,"createdAt":"2026-11-18T09:30:00.000Z","createdBy":"apk_7d4f2g9h1j6k3l8z5x0cv","updatedAt":"2026-11-21T08:40:00.000Z","columns":[{"id":"name","name":"Name","type":"name","description":null,"settings":{},"position":0},{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"}]},"position":1},{"id":"move_date","name":"Move date","type":"date","description":null,"settings":{"includeTime":false},"position":2},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day.","settings":{"multiple":false},"position":3}],"views":[{"id":"viw_3h7j1k9m2n4p6q8r0s5tx","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Table","type":"table","position":0,"config":{"filter":null,"sort":[],"group":null,"statusColumnId":null,"columns":[],"openIn":"panel"},"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"groups":[{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"In storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:31:12.550Z"},{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":1,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"itemCount":4}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}},"delete":{"operationId":"boards.delete","tags":["boards"],"summary":"Delete a board","description":"Moves the board to the trash. Its columns, views, groups and items stay, and restoring the board brings them all back. Of two deletes at once, the second answers 404.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"responses":{"200":{"description":"An empty object.","content":{"application/json":{"schema":{"type":"object","properties":{}},"example":{}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/restore":{"post":{"operationId":"boards.restore","tags":["boards"],"summary":"Restore a board","description":"Brings a deleted board back, with its columns, views, groups and items. A board that is not deleted answers 404, and so does the second of two restores at once.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"board":{"description":"The board.","$ref":"#/components/schemas/Board"}},"required":["board"]},"example":{"board":{"id":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Local moves","itemWord":"move","mainStatusColumnId":"status","mainPersonColumnId":"crew_lead","mainDateColumnId":"move_date","claimEnabled":false,"createdAt":"2026-11-18T09:30:00.000Z","createdBy":"apk_7d4f2g9h1j6k3l8z5x0cv","updatedAt":"2026-11-21T09:15:00.000Z","columns":[{"id":"name","name":"Name","type":"name","description":null,"settings":{},"position":0},{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"}]},"position":1},{"id":"move_date","name":"Move date","type":"date","description":null,"settings":{"includeTime":false},"position":2},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day.","settings":{"multiple":false},"position":3}],"views":[{"id":"viw_3h7j1k9m2n4p6q8r0s5tx","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Table","type":"table","position":0,"config":{"filter":null,"sort":[],"group":null,"statusColumnId":null,"columns":[],"openIn":"panel"},"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"groups":[{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"In storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:31:12.550Z"},{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":1,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}],"itemCount":4}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/columns":{"post":{"operationId":"columns.create","tags":["columns"],"summary":"Create a column","description":"Adds a column with the ID you choose, or one made from its type. It goes right after `afterColumnId` (`name` puts it first), or last. A board holds at most 60 columns besides Name; past that it answers 409 `LIMIT_REACHED`. A column whose type's indexed role is empty takes the role.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"text","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"long_text","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"number","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsNumberInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"status","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsStatusInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"dropdown","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsDropdownInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"person","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsPersonInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"date","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsDateInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"link","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"phone","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsPhoneInput"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"email","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Left out, the type's defaults apply.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"description":"The column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter, unique on the board. Left out, the API makes one from the type, such as `status_k3x9p2ma`.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"button","description":"The column's type."},"description":{"description":"The column's description, up to 500 characters, or null.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The column's settings. Required for this type.","$ref":"#/components/schemas/ColumnSettingsButton"},"afterColumnId":{"description":"Put the column right after this one; `name` puts it first. Left out, it goes last. Ignored when creating a board.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"}},"required":["name","type","settings"],"additionalProperties":false}],"description":"A new column. `type` decides which `settings` it takes."},"example":{"id":"customer_phone","name":"Customer phone","type":"phone","settings":{"defaultCountry":"US"},"afterColumnId":"name"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"column":{"description":"The column.","$ref":"#/components/schemas/Column"}},"required":["column"]},"example":{"column":{"id":"customer_phone","name":"Customer phone","type":"phone","description":null,"settings":{"defaultCountry":"US"},"position":1}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"- `COLUMN_ID_TAKEN`: The column ID is already used on the board, by a deleted column too. Choose another.\n- `LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"COLUMN_ID_TAKEN":{"value":{"error":{"code":"COLUMN_ID_TAKEN"}}},"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/columns/{columnId}":{"patch":{"operationId":"columns.update","tags":["columns"],"summary":"Update a column","description":"Changes the name, the description or the settings. `settings` is the whole of them and is checked against the column's type in a second step; a label or option left out is removed and its cells emptied. Send `dryRun: true` to count those items without writing anything. The Name column cannot be changed (409 `COLUMN_PROTECTED`), and when others change the column at the same moment it may answer 503 `UNAVAILABLE`; send it again.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"columnId","in":"path","required":true,"description":"The column's ID.","schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"example":"status"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name, 1 to 50 characters.","type":"string","minLength":1,"maxLength":50},"description":{"description":"The new description, up to 500 characters; null clears it.","anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}]},"settings":{"description":"The whole of the column's settings, checked against the column's type. A label or option left out is removed, and the cells that hold it are emptied. A date column's `includeTime` cannot change.","anyOf":[{"$ref":"#/components/schemas/ColumnSettingsStatusInput"},{"$ref":"#/components/schemas/ColumnSettingsDropdownInput"},{"$ref":"#/components/schemas/ColumnSettingsButton"},{"$ref":"#/components/schemas/ColumnSettingsNumberInput"},{"$ref":"#/components/schemas/ColumnSettingsPersonInput"},{"$ref":"#/components/schemas/ColumnSettingsDateInput"},{"$ref":"#/components/schemas/ColumnSettingsPhoneInput"},{"$ref":"#/components/schemas/ColumnSettingsEmpty"}]},"dryRun":{"description":"With true, nothing is written: the answer only counts the items that would lose a label or option.","type":"boolean"}},"additionalProperties":false,"description":"The fields to change. Send at least one besides `dryRun`."},"example":{"name":"Stage","settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"},{"name":"On hold","color":"grey"}]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"column":{"description":"The column after the change; on a dry run, the column as it is.","$ref":"#/components/schemas/Column"},"dryRun":{"type":"boolean","description":"Whether this was a dry run."},"clearedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The items whose cell held a label or option the request removed: emptied, or on a dry run, that would be."}},"required":["column","dryRun","clearedCount"]},"example":{"column":{"id":"status","name":"Stage","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"},{"id":"h5c8z3qe","name":"On hold","color":"grey"}]},"position":1},"dryRun":false,"clearedCount":0}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}},"delete":{"operationId":"columns.delete","tags":["columns"],"summary":"Delete a column","description":"Moves the column to the trash. Its values stay, and restoring the column brings them back. An indexed role it held passes to the next column that fits, or is emptied when none does. With Claim on, the person role is emptied, not passed on. The Name column cannot be deleted (409 `COLUMN_PROTECTED`).","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"columnId","in":"path","required":true,"description":"The column's ID.","schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"example":"customer_phone"}],"responses":{"200":{"description":"An empty object.","content":{"application/json":{"schema":{"type":"object","properties":{}},"example":{}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/columns/{columnId}/restore":{"post":{"operationId":"columns.restore","tags":["columns"],"summary":"Restore a column","description":"Brings a deleted column back with its values, at its own place in the board's order: after the columns that were before it when it was deleted. It takes its type's indexed role when that role is empty; with Claim on, it takes the person role only if it held that role when it was deleted. A board already at 60 columns answers 409 `LIMIT_REACHED`, and a column that is not deleted answers 404.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"columnId","in":"path","required":true,"description":"The column's ID.","schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"example":"customer_phone"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"column":{"description":"The column.","$ref":"#/components/schemas/Column"}},"required":["column"]},"example":{"column":{"id":"customer_phone","name":"Customer phone","type":"phone","description":null,"settings":{"defaultCountry":"US"},"position":1}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/columns/{columnId}/duplicate":{"post":{"operationId":"columns.duplicate","tags":["columns"],"summary":"Duplicate a column","description":"Copies a column right after the original, with its values unless `withValues` is false. Left out, the copy's name is the original's with \" copy\" added, and its ID is made from the type. The body may be empty. The 60-column limit applies, and the Name column cannot be copied (409 `COLUMN_PROTECTED`).","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"columnId","in":"path","required":true,"description":"The column's ID.","schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"example":"move_date"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The copy's name, 1 to 50 characters. Left out, the original's name and \" copy\".","type":"string","minLength":1,"maxLength":50},"id":{"description":"The copy's ID, unique on the board. Left out, the API makes one from the type.","type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"withValues":{"default":true,"description":"Whether to copy the values too. Defaults to true.","type":"boolean"}},"additionalProperties":false},"example":{"id":"delivery_date","name":"Delivery date","withValues":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"column":{"description":"The column.","$ref":"#/components/schemas/Column"}},"required":["column"]},"example":{"column":{"id":"delivery_date","name":"Delivery date","type":"date","description":null,"settings":{"includeTime":false},"position":3}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"- `COLUMN_ID_TAKEN`: The column ID is already used on the board, by a deleted column too. Choose another.\n- `COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.\n- `LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"COLUMN_ID_TAKEN":{"value":{"error":{"code":"COLUMN_ID_TAKEN"}}},"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}},"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/columns/{columnId}/change-type":{"post":{"operationId":"columns.changeType","tags":["columns"],"summary":"Change a column's type","description":"Converts the column's values to another type; values that cannot convert are emptied. Send `dryRun: true` to count them first without writing anything. `settings` is for the new type and is checked against it in a second step; left out, the type's defaults apply, with labels or options made from the values. When the values are converted one by one, a column of more than 10,000 values or 8 MiB of values answers 409 `LIMIT_REACHED`. A change to Button, text to long text, and email or phone to text or long text convert no value one by one and have no such limit. The Name column cannot change type (409 `COLUMN_PROTECTED`).","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"columnId","in":"path","required":true,"description":"The column's ID.","schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"example":"truck"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["text","long_text","number","status","dropdown","person","date","link","phone","email","button"],"description":"The new type."},"settings":{"description":"Settings for the new type, checked against it. Left out, the type's defaults apply, with labels or options made from the values where the types allow it. A button needs them.","anyOf":[{"$ref":"#/components/schemas/ColumnSettingsStatusInput"},{"$ref":"#/components/schemas/ColumnSettingsDropdownInput"},{"$ref":"#/components/schemas/ColumnSettingsButton"},{"$ref":"#/components/schemas/ColumnSettingsNumberInput"},{"$ref":"#/components/schemas/ColumnSettingsPersonInput"},{"$ref":"#/components/schemas/ColumnSettingsDateInput"},{"$ref":"#/components/schemas/ColumnSettingsPhoneInput"},{"$ref":"#/components/schemas/ColumnSettingsEmpty"}]},"dryRun":{"default":false,"description":"With true, nothing is written: the answer only counts the values. Defaults to false.","type":"boolean"}},"required":["type"],"additionalProperties":false},"example":{"type":"dropdown"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dryRun":{"type":"boolean","description":"Whether this was a dry run."},"valueCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The number of values the column holds."},"unconvertibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of them cannot be converted: emptied by a real change (the change log keeps them), or on a dry run, that would be."},"column":{"anyOf":[{"$ref":"#/components/schemas/Column"},{"type":"null"}],"description":"The changed column; null on a dry run."}},"required":["dryRun","valueCount","unconvertibleCount","column"]},"example":{"dryRun":false,"valueCount":12,"unconvertibleCount":0,"column":{"id":"truck","name":"Truck","type":"dropdown","description":null,"settings":{"options":[{"id":"v3n8b1qa","name":"Van","color":"blue"},{"id":"t6r2k9mz","name":"Box truck","color":"purple"}],"multiple":false},"position":4}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"- `COLUMN_PROTECTED`: The Name column cannot be changed with a `PATCH`, deleted, copied or change type, and cannot be named as one of the board's indexed columns.\n- `LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"COLUMN_PROTECTED":{"value":{"error":{"code":"COLUMN_PROTECTED"}}},"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/columns/order":{"post":{"operationId":"columns.order","tags":["columns"],"summary":"Order columns","description":"Send every live column ID except `name`, once each, in the new order. Anything else answers 400 `INVALID_REQUEST` with the reason `order_mismatch`, as does a column created while the request ran. An order the board already has answers 200 and writes nothing.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"columnIds":{"maxItems":600,"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter. `name` is kept for the Name column."},"description":"Every live column ID except `name`, once each, in the new order. Up to 600."}},"required":["columnIds"],"additionalProperties":false},"example":{"columnIds":["move_date","status","crew_lead"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"},"description":"The board's live columns in the new order, Name first."}},"required":["columns"]},"example":{"columns":[{"id":"name","name":"Name","type":"name","description":null,"settings":{},"position":0},{"id":"move_date","name":"Move date","type":"date","description":null,"settings":{"includeTime":false},"position":1},{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k4m9q2xa","name":"Booked","color":"blue"},{"id":"p7t3w8nc","name":"Packing","color":"amber"},{"id":"d2h6j1rv","name":"Moved","color":"teal"}]},"position":2},{"id":"crew_lead","name":"Crew lead","type":"person","description":"Who runs the crew on the day.","settings":{"multiple":false},"position":3}]}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/views":{"post":{"operationId":"views.create","tags":["views"],"summary":"Create a view","description":"Adds a Table or Kanban view, placed last, with the default settings and whatever `config` names. A Kanban view needs nothing on the board: `config.statusColumnId` may name a live status column of the board, or be null (the default); any other column answers 400 `INVALID_REQUEST`. The filter, sort, Group by and column list may name only columns the board has, and the Group by cannot be on Name, a button or a column that holds several values (400 `GROUPING_NOT_ALLOWED`). A board holds at most 30 views.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_4f8k2n7q1w9e3r6t5y0u2"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40,"description":"The view's name, 1 to 40 characters after trimming."},"type":{"type":"string","enum":["table","kanban"],"description":"`table` or `kanban`. It cannot change later."},"config":{"description":"The settings to start with. Name only the ones to set; each one left out takes its default: no filter, sort or Group by, no status column, every column shown in the board's order, and items open in the panel.","type":"object","properties":{"filter":{"description":"The view's saved filter, the same shape as the items query's `filter`. Null means none.","anyOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}]},"sort":{"description":"The view's saved sort, the same shape as the items query's `sort`. Empty means none.","$ref":"#/components/schemas/Sort"},"group":{"description":"The view's saved Group by, the same shape as the items query's `group`. Null means none. Name cannot be grouped by (400 `GROUPING_NOT_ALLOWED`); a Group by on Name saved before that stays as it is, and the view runs as if it had none.","anyOf":[{"$ref":"#/components/schemas/GroupBy"},{"type":"null"}]},"statusColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The status column a Kanban view groups its cards by: a live status column of the board, or null. Null means the view has not picked one; the app then uses the board's indexed status column, then its first status column. A Table view ignores it."},"columns":{"maxItems":61,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. `name` is the Name column."},"hidden":{"type":"boolean","description":"True hides the column in this view. The Name column cannot be hidden."},"width":{"anyOf":[{"type":"integer","minimum":48,"maximum":1200},{"type":"null"}],"description":"The column's width in pixels, 48 to 1,200. Null is the default width."},"wrap":{"type":"boolean","description":"True wraps long text in the column's cells."}},"required":["id","hidden","width","wrap"],"additionalProperties":false,"description":"How one column shows in the view."},"description":"How each column shows, in the order shown: up to 61 entries (the board's 60 columns and Name), each column once, and only columns the board has. A board column left out shows after the listed ones, visible, at the default width."},"openIn":{"type":"string","enum":["panel","page"],"description":"Whether items open in the side panel (`panel`, the default) or as a full page (`page`). Stored; it has no effect yet."}},"additionalProperties":false}},"required":["name","type"],"additionalProperties":false},"example":{"name":"Pipeline","type":"kanban","config":{"statusColumnId":"status","sort":[{"column":"move_date","direction":"asc"}]}}}}},"responses":{"201":{"description":"The new view.","content":{"application/json":{"schema":{"type":"object","properties":{"view":{"description":"The view as the board shows it now. Its column list leaves out columns the board no longer has.","$ref":"#/components/schemas/View"}},"required":["view"]},"example":{"view":{"id":"viw_7d3g5k8n2q4t6w9y1a0e5","boardId":"brd_4f8k2n7q1w9e3r6t5y0u2","name":"Pipeline","type":"kanban","position":1,"config":{"filter":null,"sort":[{"column":"move_date","direction":"asc"}],"group":null,"statusColumnId":"status","columns":[],"openIn":"panel"},"createdAt":"2026-11-18T14:05:12.412Z","updatedAt":"2026-11-18T14:05:12.412Z"}}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `QUERY_INVALID`: The query names a column the board lacks, an operator or value that does not fit its column, a column that cannot be sorted, or Me, which a key cannot use (sent, or in a saved view). Or the query is too large to run as one statement. Most answers say where in `details.issues`. Details: `QueryInvalidDetails`.\n- `GROUPING_NOT_ALLOWED`: The query, or a view's `group`, groups by Name, by a column that holds no value (a button) or by one that allows several values. An items query sent as fields and a view's create or update answer it; with other problems besides, they answer `QUERY_INVALID`. A saved view run by its ID leaves such a grouping out instead. `details.issues` names it. Details: `QueryInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/QueryInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"QUERY_INVALID":{"value":{"error":{"code":"QUERY_INVALID"}}},"GROUPING_NOT_ALLOWED":{"value":{"error":{"code":"GROUPING_NOT_ALLOWED"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/views/order":{"post":{"operationId":"views.order","tags":["views"],"summary":"Order the views","description":"Sets the board's tab order. Send every view ID of the board, each once, in the order to show; a missing, extra, repeated or unknown ID answers 400 `INVALID_REQUEST` and changes nothing. No view's `updatedAt` moves.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_4f8k2n7q1w9e3r6t5y0u2"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"viewIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^viw_[0-9a-z]{21}$","description":"A view's ID: `viw_` and 21 characters from 0-9 and a-z."},"description":"Every view ID of the board, each once, in the order to show."}},"required":["viewIds"],"additionalProperties":false},"example":{"viewIds":["viw_7d3g5k8n2q4t6w9y1a0e5","viw_2h6j9m3p5s8v1x4z7c0b6"]}}}},"responses":{"200":{"description":"The board's views in their new order.","content":{"application/json":{"schema":{"type":"object","properties":{"views":{"type":"array","items":{"$ref":"#/components/schemas/View"},"description":"The board's views in their new order."}},"required":["views"]},"example":{"views":[{"id":"viw_7d3g5k8n2q4t6w9y1a0e5","boardId":"brd_4f8k2n7q1w9e3r6t5y0u2","name":"Pipeline","type":"kanban","position":0,"config":{"filter":null,"sort":[{"column":"move_date","direction":"asc"}],"group":null,"statusColumnId":"status","columns":[],"openIn":"panel"},"createdAt":"2026-11-18T14:05:12.412Z","updatedAt":"2026-11-18T14:05:12.412Z"},{"id":"viw_2h6j9m3p5s8v1x4z7c0b6","boardId":"brd_4f8k2n7q1w9e3r6t5y0u2","name":"Table","type":"table","position":1,"config":{"filter":null,"sort":[],"group":null,"statusColumnId":null,"columns":[{"id":"name","hidden":false,"width":280,"wrap":false},{"id":"origin","hidden":false,"width":null,"wrap":true},{"id":"destination","hidden":false,"width":null,"wrap":true}],"openIn":"panel"},"createdAt":"2026-11-02T09:14:03.218Z","updatedAt":"2026-11-10T16:41:27.905Z"}]}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/views/{viewId}":{"patch":{"operationId":"views.update","tags":["views"],"summary":"Update a view","description":"Changes the name and the settings. Each setting named replaces the stored one whole, and the others stay. Only what the request names is checked against the board's live columns, so a stored setting that names a deleted column never blocks a change elsewhere. A `group` it names cannot be by Name (400 `GROUPING_NOT_ALLOWED`); a Group by on Name saved before that stays until it is changed. A view's type cannot change.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_4f8k2n7q1w9e3r6t5y0u2"},{"name":"viewId","in":"path","required":true,"description":"The view's ID.","schema":{"type":"string","pattern":"^viw_[0-9a-z]{21}$"},"example":"viw_7d3g5k8n2q4t6w9y1a0e5"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A new name, 1 to 40 characters after trimming.","type":"string","minLength":1,"maxLength":40},"config":{"description":"The settings to change. Each one named replaces the stored one whole; the others stay as they are.","type":"object","properties":{"filter":{"description":"The view's saved filter, the same shape as the items query's `filter`. Null means none.","anyOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}]},"sort":{"description":"The view's saved sort, the same shape as the items query's `sort`. Empty means none.","$ref":"#/components/schemas/Sort"},"group":{"description":"The view's saved Group by, the same shape as the items query's `group`. Null means none. Name cannot be grouped by (400 `GROUPING_NOT_ALLOWED`); a Group by on Name saved before that stays as it is, and the view runs as if it had none.","anyOf":[{"$ref":"#/components/schemas/GroupBy"},{"type":"null"}]},"statusColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The status column a Kanban view groups its cards by: a live status column of the board, or null. Null means the view has not picked one; the app then uses the board's indexed status column, then its first status column. A Table view ignores it."},"columns":{"maxItems":61,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. `name` is the Name column."},"hidden":{"type":"boolean","description":"True hides the column in this view. The Name column cannot be hidden."},"width":{"anyOf":[{"type":"integer","minimum":48,"maximum":1200},{"type":"null"}],"description":"The column's width in pixels, 48 to 1,200. Null is the default width."},"wrap":{"type":"boolean","description":"True wraps long text in the column's cells."}},"required":["id","hidden","width","wrap"],"additionalProperties":false,"description":"How one column shows in the view."},"description":"How each column shows, in the order shown: up to 61 entries (the board's 60 columns and Name), each column once, and only columns the board has. A board column left out shows after the listed ones, visible, at the default width."},"openIn":{"type":"string","enum":["panel","page"],"description":"Whether items open in the side panel (`panel`, the default) or as a full page (`page`). Stored; it has no effect yet."}},"additionalProperties":false}},"additionalProperties":false,"description":"Name at least one of `name` and `config`."},"example":{"config":{"filter":{"join":"and","conditions":[{"column":"move_date","operator":"is","value":{"type":"relative_date","value":"next_30_days"}}]}}}}}},"responses":{"200":{"description":"The view after the change.","content":{"application/json":{"schema":{"type":"object","properties":{"view":{"description":"The view as the board shows it now. Its column list leaves out columns the board no longer has.","$ref":"#/components/schemas/View"}},"required":["view"]},"example":{"view":{"id":"viw_7d3g5k8n2q4t6w9y1a0e5","boardId":"brd_4f8k2n7q1w9e3r6t5y0u2","name":"Pipeline","type":"kanban","position":0,"config":{"filter":{"join":"and","conditions":[{"column":"move_date","operator":"is","value":{"type":"relative_date","value":"next_30_days"}}]},"sort":[{"column":"move_date","direction":"asc"}],"group":null,"statusColumnId":"status","columns":[],"openIn":"panel"},"createdAt":"2026-11-18T14:05:12.412Z","updatedAt":"2026-11-18T14:22:48.031Z"}}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `QUERY_INVALID`: The query names a column the board lacks, an operator or value that does not fit its column, a column that cannot be sorted, or Me, which a key cannot use (sent, or in a saved view). Or the query is too large to run as one statement. Most answers say where in `details.issues`. Details: `QueryInvalidDetails`.\n- `GROUPING_NOT_ALLOWED`: The query, or a view's `group`, groups by Name, by a column that holds no value (a button) or by one that allows several values. An items query sent as fields and a view's create or update answer it; with other problems besides, they answer `QUERY_INVALID`. A saved view run by its ID leaves such a grouping out instead. `details.issues` names it. Details: `QueryInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/QueryInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"QUERY_INVALID":{"value":{"error":{"code":"QUERY_INVALID"}}},"GROUPING_NOT_ALLOWED":{"value":{"error":{"code":"GROUPING_NOT_ALLOWED"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"delete":{"operationId":"views.delete","tags":["views"],"summary":"Delete a view","description":"Removes the view for good. A board's last view cannot go: 400 `INVALID_REQUEST` with `details.reason` `last_view`. Once the board is deleted, its views stay for the board's restore, and this answers 404.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_4f8k2n7q1w9e3r6t5y0u2"},{"name":"viewId","in":"path","required":true,"description":"The view's ID.","schema":{"type":"string","pattern":"^viw_[0-9a-z]{21}$"},"example":"viw_7d3g5k8n2q4t6w9y1a0e5"}],"responses":{"200":{"description":"An empty object.","content":{"application/json":{"schema":{"type":"object","properties":{}},"example":{}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/groups":{"get":{"operationId":"groups.list","tags":["groups"],"summary":"List a board's groups","description":"The board's live groups, in the board's order: the same list as the board's `groups`. A board always has at least one. Groups in the trash are not listed.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupsAnswer"},"example":{"groups":[{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":0,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"},{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Storage","color":"purple","position":1,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:12:36.418Z"}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"post":{"operationId":"groups.create","tags":["groups"],"summary":"Create a group","description":"Adds a group to the board: last, or right before the group `before` names, which must be a live group of this board (else 400 `GROUP_INVALID`). A color left out is the one that the fewest of the board's live groups use, the first in the list of colors on a tie. A board holds at most 50 live groups; one more answers 409 `LIMIT_REACHED`. It takes no `Idempotency-Key`, so a create sent twice makes two groups.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreateRequest"},"example":{"name":"Storage"}}}},"responses":{"201":{"description":"The new group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupAnswer"},"example":{"group":{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Storage","color":"purple","position":1,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:12:36.418Z"}}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `GROUP_INVALID`: A group named in the body is not a live group of this board: unknown, deleted, or another board's or workspace's. An item create's or move's `groupId` answers it with no details; a group create's `before` answers it with `details.field` `before`. In a batch it is an entry's code inside `BATCH_INVALID`. A group in the path that is not found answers 404 instead. Details: `GroupInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/GroupInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"GROUP_INVALID":{"value":{"error":{"code":"GROUP_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/groups/order":{"put":{"operationId":"groups.order","tags":["groups"],"summary":"Order the groups","description":"Sets the order of the board's groups. Send every live group's ID, each once, in the order to show; the groups are numbered from 0 in that order, and no group's `updatedAt` moves. Any other list (a group missing, extra, repeated, deleted or of another board) answers 409 `GROUP_ORDER_MISMATCH` and changes nothing, and so does an order that a group create, delete or restore overtook: read the groups again. An order the board already has answers 200 and writes nothing. When others change the groups at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOrderRequest"},"example":{"ids":["grp_5m8c2x7v4b1n9q3k6j0hd","grp_8k2m4q7x1v9c3n5b6z0wp"]}}}},"responses":{"200":{"description":"The board's groups in their new order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupsAnswer"},"example":{"groups":[{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:12:36.418Z"},{"id":"grp_8k2m4q7x1v9c3n5b6z0wp","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"Moves","color":"blue","position":1,"createdAt":"2026-11-18T09:30:00.000Z","updatedAt":"2026-11-18T09:30:00.000Z"}]}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`GROUP_ORDER_MISMATCH`: The order is not exactly the board's live groups, each once: a group is missing, extra, repeated, deleted or another board's, or a group was created, deleted or restored while the request ran. Nothing was written; read the groups again and send the whole order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"GROUP_ORDER_MISMATCH":{"value":{"error":{"code":"GROUP_ORDER_MISMATCH"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/groups/{groupId}":{"patch":{"operationId":"groups.update","tags":["groups"],"summary":"Update a group","description":"Renames or recolors the group; send only the fields to change. A request that changes nothing answers 200 and writes nothing. A group in the trash answers 404. When others change the group at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"groupId","in":"path","required":true,"description":"The group's ID.","schema":{"type":"string","pattern":"^grp_[0-9a-z]{21}$"},"example":"grp_5m8c2x7v4b1n9q3k6j0hd"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdateRequest"},"example":{"name":"In storage"}}}},"responses":{"200":{"description":"The group after the change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupAnswer"},"example":{"group":{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"In storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:20:51.903Z"}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}},"delete":{"operationId":"groups.delete","tags":["groups"],"summary":"Delete a group","description":"Moves the group and its live items to the trash together, and answers how many items went with it. The group's archived items stay archived; unarchived while the group is in the trash, they go to the end of the board's first group. Restoring the group brings back the items that went with it. A board's last live group cannot go: 409 `LAST_GROUP`. Of two deletes at once, the second answers 404. The changes feed gets one `board_group_deleted` for the group, not one change per item. When others change the board's groups at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"groupId","in":"path","required":true,"description":"The group's ID.","schema":{"type":"string","pattern":"^grp_[0-9a-z]{21}$"},"example":"grp_5m8c2x7v4b1n9q3k6j0hd"}],"responses":{"200":{"description":"How many items went to the trash with the group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupDeleteAnswer"},"example":{"itemCount":1}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`LAST_GROUP`: The group is the board's last live group, and a board always keeps one, so it cannot be deleted. Create another group first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"LAST_GROUP":{"value":{"error":{"code":"LAST_GROUP"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/groups/{groupId}/restore":{"post":{"operationId":"groups.restore","tags":["groups"],"summary":"Restore a group","description":"Brings a group back from the trash with the items that went to the trash with it; `itemCount` says how many came back. An item sent to the trash on its own stays there. The group keeps the place number it had, and then the board's groups are numbered from 0 again. So if the order changed while it was in the trash, it lands near its old place, not always at it: when another group has the same number, the one whose ID sorts first goes first. A group that is not in the trash answers 404, and so does the second of two restores at once. A board that already has 50 live groups answers 409 `LIMIT_REACHED`. When others change the board's groups at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"groupId","in":"path","required":true,"description":"The group's ID.","schema":{"type":"string","pattern":"^grp_[0-9a-z]{21}$"},"example":"grp_5m8c2x7v4b1n9q3k6j0hd"}],"responses":{"200":{"description":"The group, and how many items came back with it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRestoreAnswer"},"example":{"group":{"id":"grp_5m8c2x7v4b1n9q3k6j0hd","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","name":"In storage","color":"purple","position":0,"createdAt":"2026-11-19T10:12:36.418Z","updatedAt":"2026-11-19T10:31:12.550Z"},"itemCount":1}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`LIMIT_REACHED`: A limit is full: a board's columns or views, its live groups (at most 50, on a group create or restore), or the values a type change would convert. `details.limit` names it and `details.max` gives the cap. Details: `LimitReachedDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/LimitReachedDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"LIMIT_REACHED":{"value":{"error":{"code":"LIMIT_REACHED"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/items":{"post":{"operationId":"items.create","tags":["items"],"summary":"Create an item","description":"Creates an item from a name and values keyed by column ID. A status or dropdown value may give a label's exact name instead of its ID. The item goes at the `end` of its group, or at the `top` when `position` says so; the group is `groupId`, a live group of this board (any other answers 400 `GROUP_INVALID`), or the board's first group when `groupId` is left out. With an `Idempotency-Key`, the same request sent again inside 24 hours gets the first answer back and creates nothing.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same key again within 24 hours to get the first answer back instead of writing twice. 1 to 128 printable characters, with no spaces.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,128}$"},"example":"a3d8f61e-hendricks-move-create-1204"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateRequest"},"example":{"name":"Hendricks, 3-bed move","values":{"status":"Booked","move_date":"2026-12-05","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]}}}}},"responses":{"201":{"description":"The new item.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"k4m9q2xa","move_date":"2026-12-05","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T14:32:07.512Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `VALUE_INVALID`: A value does not fit its column, names a label, option or person that does not exist, is too large, or sits under a key that is not a live column of the board. Nothing is written; `details.columnId` names the column. Details: `ValueInvalidDetails`.\n- `GROUP_INVALID`: A group named in the body is not a live group of this board: unknown, deleted, or another board's or workspace's. An item create's or move's `groupId` answers it with no details; a group create's `before` answers it with `details.field` `before`. In a batch it is an entry's code inside `BATCH_INVALID`. A group in the path that is not found answers 404 instead. Details: `GroupInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/ValueInvalidDetails"},{"$ref":"#/components/schemas/GroupInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"VALUE_INVALID":{"value":{"error":{"code":"VALUE_INVALID"}}},"GROUP_INVALID":{"value":{"error":{"code":"GROUP_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`IDEMPOTENCY_KEY_REUSED`: The `Idempotency-Key` was used before with a different request, or a request with the same key is still running. In the second case, send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `IDEMPOTENCY_KEY_REUSED`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"IDEMPOTENCY_KEY_REUSED":{"value":{"error":{"code":"IDEMPOTENCY_KEY_REUSED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}},"get":{"operationId":"items.list","tags":["items"],"summary":"List a board's items","description":"The board's live items in creation order, 100 a page unless `limit` says otherwise, up to 1,000. Ask again with `cursor` set to the last answer's `nextCursor` until it is null: only a null `nextCursor` ends the paging, not a short page. It is the items query with nothing set, in UTC, and its cursors work there too.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"limit","in":"query","required":false,"description":"Items per page, 1 to 1,000; 100 if left out.","schema":{"type":"integer","minimum":1,"maximum":1000},"example":1},{"name":"cursor","in":"query","required":false,"description":"The `nextCursor` of the last page, passed back unread. It works only with the query it came from, and never expires. Up to 2,048 characters.","schema":{"type":"string","minLength":1,"maxLength":2048}}],"responses":{"200":{"description":"A page of items: the query's answer, without `count`, `groups` and `groupsKind`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemsQueryAnswer"},"example":{"items":[{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"k4m9q2xa","move_date":"2026-12-04","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"}],"nextCursor":"eyJ2IjoxLCJoIjoiSk9VNk1KQlciLCJwIjoxLCJpIjoiaXRtX3hzdm96NXZ4NzVoMjF5aW4zbHBrdiIsImsiOlsxNzk1MDE0MTYxMDQ0XX0","formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `CURSOR_INVALID`: The cursor (or the updates feed's `before`) cannot be read. A cursor whose row no longer exists at all can be refused too, when the API must read that row again to go on. Start again from the first page.\n- `CURSOR_MISMATCH`: The cursor came from a different query, or was made when a relative date in the query, or its grouping by a date column, covered other days. Send it with the query it came from, or start again from the first page.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"CURSOR_INVALID":{"value":{"error":{"code":"CURSOR_INVALID"}}},"CURSOR_MISMATCH":{"value":{"error":{"code":"CURSOR_MISMATCH"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/items/batch":{"post":{"operationId":"items.batch","tags":["items"],"summary":"Create and update items in a batch","description":"Up to 100 creates and updates on one board, all or none: an entry with `id` updates that item, and one without creates an item. A create takes `groupId` and `position` as a single create does, and the new items of one group are placed in the order of the entries; an update takes neither, because a move is its own route. If any entry is wrong, nothing is written and `BATCH_INVALID` names each bad entry by its place in the list. It answers 200, not 201, with the items in the order of the entries. It takes an `Idempotency-Key` like a create.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"},{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same key again within 24 hours to get the first answer back instead of writing twice. 1 to 128 printable characters, with no spaces.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,128}$"},"example":"c52e0b97-moves-import-batch-1209"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchItemsRequest"},"example":{"items":[{"name":"Okafor, studio move","values":{"status":"Booked","move_date":"2026-12-09"}},{"id":"itm_5n2boyjqbxxur9wfm6397","values":{"move_date":"2026-12-04"}}]}}}},"responses":{"200":{"description":"The items, in the order of the entries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchItemsAnswer"},"example":{"items":[{"id":"itm_xsvoz5vx75h21yin3lpkv","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":2048,"name":"Okafor, studio move","values":{"status":"k4m9q2xa","move_date":"2026-12-09"},"createdAt":"2026-11-18T15:02:41.044Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"k4m9q2xa","move_date":"2026-12-04","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"}],"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `BATCH_INVALID`: Some entries of the batch are bad, so nothing was written. `details.errors` lists each problem with the entry's `index`. Details: `BatchInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/BatchInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"BATCH_INVALID":{"value":{"error":{"code":"BATCH_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`IDEMPOTENCY_KEY_REUSED`: The `Idempotency-Key` was used before with a different request, or a request with the same key is still running. In the second case, send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `IDEMPOTENCY_KEY_REUSED`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"IDEMPOTENCY_KEY_REUSED":{"value":{"error":{"code":"IDEMPOTENCY_KEY_REUSED"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/boards/{boardId}/items/query":{"post":{"operationId":"items.query","tags":["items"],"summary":"Query a board's items","description":"Runs a saved view, or a filter, sort, Group by and search, on the board's items, a page at a time. The `groups` layout lists the items in the board's order, group by group, and `groupIds` reads only some groups. The layout left out is `flat`, except that a saved table view with no column grouping runs in the board's order. Ask again with `cursor` set to the last answer's `nextCursor` until it is null: only a null `nextCursor` ends the paging, and a page shorter than `limit`, even an empty one, does not. `count`, `groups` and `groupsKind` come only with `counts: true`. Values hold the board's live columns only.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_8k2m4q7x1v9c3n5b6z0wp"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemsQueryRequest"},"example":{"filter":{"join":"and","conditions":[{"column":"status","operator":"is","value":"k4m9q2xa"}]},"sort":[{"column":"move_date","direction":"asc"}],"limit":25}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemsQueryAnswer"},"example":{"items":[{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"k4m9q2xa","move_date":"2026-12-04","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},{"id":"itm_xsvoz5vx75h21yin3lpkv","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":2048,"name":"Okafor, studio move","values":{"status":"k4m9q2xa","move_date":"2026-12-09"},"createdAt":"2026-11-18T15:02:41.044Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"}],"nextCursor":null,"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `QUERY_INVALID`: The query names a column the board lacks, an operator or value that does not fit its column, a column that cannot be sorted, or Me, which a key cannot use (sent, or in a saved view). Or the query is too large to run as one statement. Most answers say where in `details.issues`. Details: `QueryInvalidDetails`.\n- `GROUPING_NOT_ALLOWED`: The query, or a view's `group`, groups by Name, by a column that holds no value (a button) or by one that allows several values. An items query sent as fields and a view's create or update answer it; with other problems besides, they answer `QUERY_INVALID`. A saved view run by its ID leaves such a grouping out instead. `details.issues` names it. Details: `QueryInvalidDetails`.\n- `CURSOR_INVALID`: The cursor (or the updates feed's `before`) cannot be read. A cursor whose row no longer exists at all can be refused too, when the API must read that row again to go on. Start again from the first page.\n- `CURSOR_MISMATCH`: The cursor came from a different query, or was made when a relative date in the query, or its grouping by a date column, covered other days. Send it with the query it came from, or start again from the first page.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/QueryInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"QUERY_INVALID":{"value":{"error":{"code":"QUERY_INVALID"}}},"GROUPING_NOT_ALLOWED":{"value":{"error":{"code":"GROUPING_NOT_ALLOWED"}}},"CURSOR_INVALID":{"value":{"error":{"code":"CURSOR_INVALID"}}},"CURSOR_MISMATCH":{"value":{"error":{"code":"CURSOR_MISMATCH"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/items/{itemId}":{"get":{"operationId":"items.get","tags":["items"],"summary":"Get an item","description":"One item. An archived item is found; one in the trash is not.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"k4m9q2xa","move_date":"2026-12-04","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T15:02:41.044Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"patch":{"operationId":"items.update","tags":["items"],"summary":"Update an item","description":"Sets the whole value of each field it names and leaves the others as they are; `null` empties a value. A `PATCH` that changes nothing answers 200 with the item as stored and writes nothing: no change entry, and `updatedAt` stays. It takes no `Idempotency-Key`, because sending it again changes nothing.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdateRequest"},"example":{"values":{"status":"p7t3w8nc"}}}}},"responses":{"200":{"description":"The item as it is now.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"p7t3w8nc","move_date":"2026-12-04","crew_lead":["Hq7Lm2Rt9VxZ4bN8cW1dF6pJ3sG0kA5e"]},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T16:05:44.208Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `VALUE_INVALID`: A value does not fit its column, names a label, option or person that does not exist, is too large, or sits under a key that is not a live column of the board. Nothing is written; `details.columnId` names the column. Details: `ValueInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/ValueInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"VALUE_INVALID":{"value":{"error":{"code":"VALUE_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}},"delete":{"operationId":"items.delete","tags":["items"],"summary":"Delete an item","description":"Sends the item to the trash and answers with the item as it was. Restore brings it back. Unlike an archived item, an item in the trash is not found by its ID.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"responses":{"200":{"description":"The item as it was before it went to the trash.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"p7t3w8nc","move_date":"2026-12-04"},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-18T17:12:30.418Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/items/{itemId}/move":{"post":{"operationId":"items.move","tags":["items"],"summary":"Move an item","description":"Puts the item at the top or the end of a group of its board: `groupId`, or, when that is left out, its own group (the board's first group when its own was deleted). `position` left out means `top`, so an empty body, or none, moves the item to the top of its own group. An archived item can be moved and stays archived; one in the trash answers 404. An item already in that group with a lower `position` than each of the group's other live items (for `top`), or a higher one (for `end`), or with no other live item there, is answered as it is and nothing is written. Otherwise it moves and one `item_moved` change is written, even when it shares that lowest or highest `position` with another item. It takes no `Idempotency-Key`: sent again, it finds the item already there. When others change the board at the same moment and it runs out of tries, it answers 503 `UNAVAILABLE` and writes nothing; send it again after `Retry-After` seconds.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_xsvoz5vx75h21yin3lpkv"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMoveRequest"},"example":{"groupId":"grp_5m8c2x7v4b1n9q3k6j0hd","position":"end"}}}},"responses":{"200":{"description":"The item after the move.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_xsvoz5vx75h21yin3lpkv","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_5m8c2x7v4b1n9q3k6j0hd","position":1024,"name":"Okafor, studio move","values":{"status":"k4m9q2xa","move_date":"2026-12-09"},"createdAt":"2026-11-18T15:02:41.044Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-19T10:14:05.227Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `GROUP_INVALID`: A group named in the body is not a live group of this board: unknown, deleted, or another board's or workspace's. An item create's or move's `groupId` answers it with no details; a group create's `before` answers it with `details.field` `before`. In a batch it is an entry's code inside `BATCH_INVALID`. A group in the path that is not found answers 404 instead. Details: `GroupInvalidDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/InvalidRequestDetails"},{"$ref":"#/components/schemas/GroupInvalidDetails"}]}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"GROUP_INVALID":{"value":{"error":{"code":"GROUP_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/items/{itemId}/archive":{"post":{"operationId":"items.archive","tags":["items"],"summary":"Archive an item","description":"Archives the item: it leaves the board's lists, but it is still found by its ID and by a query with `archived: true`, and unarchive brings it back. Archive is not the trash: a delete sends an item to the trash, and restore brings it back from there. An item already archived is answered as it is.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"p7t3w8nc","move_date":"2026-12-04"},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-12-06T09:15:30.871Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":"2026-12-06T09:15:30.871Z","createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/items/{itemId}/unarchive":{"post":{"operationId":"items.unarchive","tags":["items"],"summary":"Unarchive an item","description":"Brings an archived item back to the board's lists, in its own group with the `position` it had (items added or moved meanwhile may come before it or share that number; the item ID breaks a tie), or at the end of the board's first group when its own group is in the trash. An item that is not archived is answered as it is.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"p7t3w8nc","move_date":"2026-12-04"},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-12-07T11:40:02.395Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/items/{itemId}/restore":{"post":{"operationId":"items.restore","tags":["items"],"summary":"Restore an item","description":"Brings an item back from the trash, in its own group with the `position` it had (items added or moved meanwhile may come before it or share that number; the item ID breaks a tie), or at the end of the board's first group when its own group is in the trash too. An item that is not in the trash is answered as it is. An archived item comes back with unarchive instead. An item that went to the trash with its group comes back with the group's restore, or alone with this route.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_5n2boyjqbxxur9wfm6397"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnswer"},"example":{"item":{"id":"itm_5n2boyjqbxxur9wfm6397","boardId":"brd_8k2m4q7x1v9c3n5b6z0wp","groupId":"grp_8k2m4q7x1v9c3n5b6z0wp","position":1024,"name":"Hendricks, 3-bed move","values":{"status":"p7t3w8nc","move_date":"2026-12-04"},"createdAt":"2026-11-18T14:32:07.512Z","createdBy":"apk_xghhfpw3ki1zdys219nfi","updatedAt":"2026-11-19T08:21:16.630Z","updatedBy":"apk_xghhfpw3ki1zdys219nfi","archivedAt":null,"createdByType":"api_key","updatedByType":"api_key"},"formerMembers":[],"apiKeys":[{"id":"apk_xghhfpw3ki1zdys219nfi","name":"Booking sync","revoked":false}]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}},"503":{"description":"`UNAVAILABLE`: Others changed the same thing at the same moment and the write ran out of tries or of its statement budget. Or the answer stored for the `Idempotency-Key` was kept in parts and a part is gone. Nothing was written; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `UNAVAILABLE`.","schema":{"type":"integer","minimum":0},"example":1}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAVAILABLE":{"value":{"error":{"code":"UNAVAILABLE"}}}}}}}}}},"/v1/items/{itemId}/notes":{"get":{"operationId":"notes.get","tags":["notes"],"summary":"Get an item's notes","description":"An item's notes are one Markdown document, read whole. An item whose notes were never saved answers empty Markdown at version 0, with no author or time. An archived item's notes can be read; a deleted item answers 404.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"}],"responses":{"200":{"description":"The note itself, with no wrapper.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"},"example":{"markdown":"## Access\nElevator booked 9–11am. Loading dock on Pine St; ask the front desk for the code.\n\n## Inventory\n- 2-bedroom, about 40 boxes\n- Upright piano: needs a third mover","version":3,"updatedAt":"2026-11-17T14:05:31.218Z","updatedBy":"Hq7Lm2Xp9Rt4Vw6Yz1Bc3Df5Gh8Jk0Ns","updatedByType":"member","apiKeys":[]}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"put":{"operationId":"notes.save","tags":["notes"],"summary":"Save an item's notes","description":"Replaces the whole Markdown, but only while `baseVersion` is the version the notes have now (0 when none are saved), and answers the saved note one version higher. Otherwise nothing is written and the answer is 409 `NOTES_CONFLICT` with the current note in `details.note`. To overwrite it, send your Markdown again with that note's `version` as `baseVersion`. A key's save is recorded under the key.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"markdown":{"type":"string","maxLength":100000,"description":"The whole notes, in Markdown, up to 100,000 characters. It replaces what is saved."},"baseVersion":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The `version` of the notes you started from: 0 when none are saved yet."}},"required":["markdown","baseVersion"],"additionalProperties":false},"example":{"markdown":"## Access\nElevator booked 9–11am. Loading dock on Pine St; ask the front desk for the code.\n\n## Inventory\n- 2-bedroom, about 40 boxes\n- Upright piano: needs a third mover\n\n## Quote\nSent $1,840 on Nov 17.","baseVersion":3}}}},"responses":{"200":{"description":"The saved note itself, with no wrapper.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"},"example":{"markdown":"## Access\nElevator booked 9–11am. Loading dock on Pine St; ask the front desk for the code.\n\n## Inventory\n- 2-bedroom, about 40 boxes\n- Upright piano: needs a third mover\n\n## Quote\nSent $1,840 on Nov 17.","version":4,"updatedAt":"2026-11-17T15:42:09.486Z","updatedBy":"apk_3f8h2j6l9p1r4t7w0y5ab","updatedByType":"api_key","apiKeys":[{"id":"apk_3f8h2j6l9p1r4t7w0y5ab","name":"Quote sync","revoked":false}]}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"409":{"description":"`NOTES_CONFLICT`: The save's `baseVersion` is not the notes' current version, so nothing was written. `details.note` holds the notes as they are now; to overwrite them, send again with its `version`. Details: `NotesConflictDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/NotesConflictDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"NOTES_CONFLICT":{"value":{"error":{"code":"NOTES_CONFLICT"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/items/{itemId}/feed":{"get":{"operationId":"updates.feed","tags":["updates"],"summary":"List an item's updates","description":"The item's comments, posts and changes in one list, newest first. For the next page, send the answer's `nextBefore` as `before`; it is null at the end. Deleted comments and posts are left out.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"},{"name":"before","in":"query","required":false,"description":"The last answer's `nextBefore`, as it was given. Leave it out for the newest entries.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"limit","in":"query","required":false,"description":"How many entries to answer: a whole number, 50 by default, 200 at most.","schema":{"type":"integer","minimum":1,"maximum":200},"example":3}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedAnswer"},"example":{"entries":[{"kind":"post","id":"upd_9c4e7g1k5m8p2s6u0x3za","actorType":"api_key","actorId":"apk_3f8h2j6l9p1r4t7w0y5ab","body":"Quote sent from Quote sync: $1,840 for the 2-bedroom move on Dec 4.","createdAt":"2026-11-17T15:42:09.120Z","editedAt":null},{"kind":"change","id":"chg_1873","actorType":"api_key","actorId":"apk_3f8h2j6l9p1r4t7w0y5ab","createdAt":"2026-11-17T15:42:08.904Z","change":{"place":1873,"boardId":"brd_5n8q2t6w9z3c7f1j4m0pa","kind":"item_changed","actorType":"api_key","actorId":"apk_3f8h2j6l9p1r4t7w0y5ab","itemId":"itm_7k2m9q4x8b1n5v3c6z0wd","columnId":"status","oldValue":"new_lead","newValue":"quote_sent","createdAt":"2026-11-17T15:42:08.904Z"}},{"kind":"comment","id":"upd_2b5d8f1h4k7n0q3t6w9yc","actorType":"member","actorId":"Wn4Kc8Tq1Zr6Hy3Mb9Pv2Lx5Dg7Fs0Ja","body":"Customer asked to move the date to Dec 4.","createdAt":"2026-11-17T09:13:51.377Z","editedAt":null}],"nextBefore":"1794906831377.u.upd_2b5d8f1h4k7n0q3t6w9yc","formerMembers":[{"id":"Wn4Kc8Tq1Zr6Hy3Mb9Pv2Lx5Dg7Fs0Ja","name":"Dana Ortiz"}],"apiKeys":[{"id":"apk_3f8h2j6l9p1r4t7w0y5ab","name":"Quote sync","revoked":false}]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `CURSOR_INVALID`: The cursor (or the updates feed's `before`) cannot be read. A cursor whose row no longer exists at all can be refused too, when the API must read that row again to go on. Start again from the first page.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"CURSOR_INVALID":{"value":{"error":{"code":"CURSOR_INVALID"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/items/{itemId}/updates":{"post":{"operationId":"updates.create","tags":["updates"],"summary":"Create an update","description":"Writes an update on the item. From an API key it is a post (`kind: \"post\"`, `actorType: \"api_key\"`); from a member, a comment. The text is plain, trimmed, 1 to 4,000 characters. Archived items take updates too.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000,"description":"The text: plain, not Markdown. Trimmed, then 1 to 4,000 characters."}},"required":["body"],"additionalProperties":false},"example":{"body":"Quote sent from Quote sync: $1,840 for the 2-bedroom move on Dec 4."}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"update":{"description":"The comment or post as it is saved.","$ref":"#/components/schemas/Update"}},"required":["update"]},"example":{"update":{"kind":"post","id":"upd_9c4e7g1k5m8p2s6u0x3za","actorType":"api_key","actorId":"apk_3f8h2j6l9p1r4t7w0y5ab","body":"Quote sent from Quote sync: $1,840 for the 2-bedroom move on Dec 4.","createdAt":"2026-11-17T15:42:09.120Z","editedAt":null}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/items/{itemId}/updates/{updateId}":{"patch":{"operationId":"updates.edit","tags":["updates"],"summary":"Edit an update","description":"Changes the text of a comment or post and sets `editedAt`. Only its author may: a key edits only its own posts, and anyone else gets 403 `FORBIDDEN`. Sending the text it already has changes nothing.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"},{"name":"updateId","in":"path","required":true,"description":"The comment's or post's ID.","schema":{"type":"string","pattern":"^upd_[0-9a-z]{21}$"},"example":"upd_9c4e7g1k5m8p2s6u0x3za"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000,"description":"The text: plain, not Markdown. Trimmed, then 1 to 4,000 characters."}},"required":["body"],"additionalProperties":false},"example":{"body":"Quote sent from Quote sync: $1,920 for the 2-bedroom move on Dec 4, piano included."}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"update":{"description":"The comment or post as it is saved.","$ref":"#/components/schemas/Update"}},"required":["update"]},"example":{"update":{"kind":"post","id":"upd_9c4e7g1k5m8p2s6u0x3za","actorType":"api_key","actorId":"apk_3f8h2j6l9p1r4t7w0y5ab","body":"Quote sent from Quote sync: $1,920 for the 2-bedroom move on Dec 4, piano included.","createdAt":"2026-11-17T15:42:09.120Z","editedAt":"2026-11-17T16:03:27.645Z"}}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"403":{"description":"`FORBIDDEN`: The key may not do this. Editing or deleting an update someone else wrote answers it with no details; a route for people signed in to the app answers it with `details.reason` `session_required`; claiming an item, which is for people, answers it with `details.reason` `not_a_person`. Details: `ForbiddenDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/ForbiddenDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"FORBIDDEN":{"value":{"error":{"code":"FORBIDDEN"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"413":{"description":"`PAYLOAD_TOO_LARGE`: The body is over its route's size limit. A save of notes with too many characters answers it too, with `details.limit` `notes` and `details.max`. Details: `PayloadTooLargeDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/PayloadTooLargeDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"PAYLOAD_TOO_LARGE":{"value":{"error":{"code":"PAYLOAD_TOO_LARGE"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}},"delete":{"operationId":"updates.delete","tags":["updates"],"summary":"Delete an update","description":"Deletes a comment or post, and hides it from every read at once. Only its author may: a key deletes only its own posts, and anyone else gets 403 `FORBIDDEN`. An update deleted already answers 404.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_7k2m9q4x8b1n5v3c6z0wd"},{"name":"updateId","in":"path","required":true,"description":"The comment's or post's ID.","schema":{"type":"string","pattern":"^upd_[0-9a-z]{21}$"},"example":"upd_9c4e7g1k5m8p2s6u0x3za"}],"responses":{"200":{"description":"An empty object.","content":{"application/json":{"schema":{"type":"object","properties":{}},"example":{}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"403":{"description":"`FORBIDDEN`: The key may not do this. Editing or deleting an update someone else wrote answers it with no details; a route for people signed in to the app answers it with `details.reason` `session_required`; claiming an item, which is for people, answers it with `details.reason` `not_a_person`. Details: `ForbiddenDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/ForbiddenDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"FORBIDDEN":{"value":{"error":{"code":"FORBIDDEN"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/boards/{boardId}/changes":{"get":{"operationId":"changes.board","tags":["changes"],"summary":"List a board's changes","description":"The changes to a board's items, columns, groups and the board itself after a place, oldest first. Leave out `after` to get no changes and the latest place in `nextPlace`: note it before you load the board, then pass it as `after` to follow what changes next. While `hasMore` is true, more changes are waiting. A group's delete or restore is one change, `board_group_deleted` or `board_group_restored`, not one per item: read it as the group's items going to the trash with it, or coming back. An item moved to another group or place is `item_moved`, except that an unarchive or restore that puts the item at the end of the board's first group, because its own group is in the trash, writes only `item_unarchived` or `item_restored`: read the item for its group. Skip a kind you do not know: new ones can be added. A place higher than your workspace's latest answers 400 `CHANGE_PLACE_UNKNOWN`; reload the board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"The board's ID.","schema":{"type":"string","pattern":"^brd_[0-9a-z]{21}$"},"example":"brd_7k2m9x4p1q8v3z6n5t0wr"},{"name":"after","in":"query","required":false,"description":"Return the changes after this place: a whole number, the `nextPlace` of your last answer. Leave it out to get no changes and the latest place.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991},"example":0},{"name":"limit","in":"query","required":false,"description":"How many changes at most: a whole number from 1 to 1,000. 100 if left out.","schema":{"type":"integer","minimum":1,"maximum":1000},"example":100}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardChangesAnswer"},"example":{"changes":[{"place":41868,"boardId":"brd_7k2m9x4p1q8v3z6n5t0wr","kind":"board_created","actorType":"member","actorId":"Q3vR7nX2kLp9sT4wYb8mZc1dF6gHj0aE","itemId":null,"columnId":null,"oldValue":null,"newValue":{"name":"Orders","itemWord":"order","claimEnabled":false,"mainStatusColumnId":"status","mainPersonColumnId":null,"mainDateColumnId":null,"columns":[{"id":"status","name":"Status","type":"status","description":null,"settings":{"labels":[{"id":"k3m9x2qa","name":"New","color":"blue"},{"id":"p7d2w8nc","name":"Packed","color":"amber"},{"id":"r5x8c1ve","name":"Shipped","color":"teal"}]},"position":1}]},"createdAt":"2026-11-18T13:58:40.217Z"},{"place":41870,"boardId":"brd_7k2m9x4p1q8v3z6n5t0wr","kind":"item_created","actorType":"member","actorId":"Q3vR7nX2kLp9sT4wYb8mZc1dF6gHj0aE","itemId":"itm_3f8h1k6m0p4r7t2v9x5zb","columnId":null,"oldValue":null,"newValue":{"name":"Order 1042","values":{"status":"k3m9x2qa"},"groupId":"grp_7k2m9x4p1q8v3z6n5t0wr","position":1024},"createdAt":"2026-11-18T14:01:05.932Z"},{"place":41873,"boardId":"brd_7k2m9x4p1q8v3z6n5t0wr","kind":"item_changed","actorType":"member","actorId":"Q3vR7nX2kLp9sT4wYb8mZc1dF6gHj0aE","itemId":"itm_3f8h1k6m0p4r7t2v9x5zb","columnId":"status","oldValue":"k3m9x2qa","newValue":"p7d2w8nc","createdAt":"2026-11-18T14:03:12.481Z"}],"nextPlace":41873,"hasMore":false,"apiKeys":[]}}}},"400":{"description":"- `INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.\n- `CHANGE_PLACE_UNKNOWN`: The `after` place is one the changes feed does not know: higher than your workspace's latest. Ask without `after` for the latest place, then load the board again.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}},"CHANGE_PLACE_UNKNOWN":{"value":{"error":{"code":"CHANGE_PLACE_UNKNOWN"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/items/{itemId}/changes":{"get":{"operationId":"changes.item","tags":["changes"],"summary":"List an item's changes","description":"One item's changes, newest first. To read older ones, pass the last answer's `nextBefore` as `before`; it is null at the end. The item may be archived; a deleted item answers 404.","parameters":[{"name":"itemId","in":"path","required":true,"description":"The item's ID.","schema":{"type":"string","pattern":"^itm_[0-9a-z]{21}$"},"example":"itm_3f8h1k6m0p4r7t2v9x5zb"},{"name":"before","in":"query","required":false,"description":"Return the changes before this place: a whole number, the `nextBefore` of your last answer. Leave it out to start from the newest.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"description":"How many changes at most: a whole number from 1 to 1,000. 100 if left out.","schema":{"type":"integer","minimum":1,"maximum":1000},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemChangesAnswer"},"example":{"changes":[{"place":41902,"boardId":"brd_7k2m9x4p1q8v3z6n5t0wr","kind":"item_changed","actorType":"api_key","actorId":"apk_9w4c2n7h5j1b8d3g6l0qs","itemId":"itm_3f8h1k6m0p4r7t2v9x5zb","columnId":"status","oldValue":"p7d2w8nc","newValue":"r5x8c1ve","createdAt":"2026-11-18T15:20:47.106Z"}],"nextBefore":41902,"apiKeys":[{"id":"apk_9w4c2n7h5j1b8d3g6l0qs","name":"Order sync","revoked":false}]}}}},"400":{"description":"`INVALID_REQUEST`: The body, a query parameter or the `Idempotency-Key` does not match its schema, or the request names something the board does not have or allow, such as a column order that is not every column once or the board's last view to delete. An ID in the path that is not shaped like one answers 404 instead. Some refusals carry `details.reason`, which says why, and `details.field`, which names the field when one is at fault. Details: `InvalidRequestDetails`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"details":{"$ref":"#/components/schemas/InvalidRequestDetails"}},"required":["code"]}},"required":["error"]}]},"examples":{"INVALID_REQUEST":{"value":{"error":{"code":"INVALID_REQUEST"}}}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"404":{"description":"`NOT_FOUND`: There is no such board, column, view, group, item or update in the key's workspace (another workspace's counts as none, and so does another board's group in the path), or it was deleted while the request ran. A restore of a board, column or group that is not in the trash answers it too. Nothing is written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"NOT_FOUND":{"value":{"error":{"code":"NOT_FOUND"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}},"/v1/workspace/members":{"get":{"operationId":"members.list","tags":["members"],"summary":"List the workspace's members","description":"The people in the workspace, owner first and then by when they joined, and its seats. A person column holds a member's `userId`. A key gets what any member sees: no `invitations`, and `isYou` is false for everyone.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersAnswer"},"example":{"members":[{"id":"Fh2kP9qLm4XzR7tWc1VbN8sJd3GyA6uE","userId":"Q3vR7nX2kLp9sT4wYb8mZc1dF6gHj0aE","name":"Dana Reyes","email":"dana@example.com","role":"owner","isYou":false},{"id":"a8TnW3eYq6Rk1Lm5Zp0Xc9Vb2Hd7Gs4J","userId":"M7bX1cQ8vN4kT2wR9pL6sZ3yH0fJ5gDa","name":"Sam Ortiz","email":"sam@example.com","role":"member","isYou":false}],"seats":{"used":2,"limit":10}}}}},"401":{"description":"`UNAUTHENTICATED`: No key was sent, or the key does not work: the header is not `Bearer <key>`, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had an `Authorization` header, it comes with `WWW-Authenticate: Bearer`.","headers":{"WWW-Authenticate":{"description":"`Bearer`, sent when the request had an `Authorization` header.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"UNAUTHENTICATED":{"value":{"error":{"code":"UNAUTHENTICATED"}}}}}}},"429":{"description":"`RATE_LIMITED`: Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after `Retry-After` seconds.","headers":{"Retry-After":{"description":"How many seconds to wait before sending again. Sent with `RATE_LIMITED`.","schema":{"type":"integer","minimum":0},"example":10}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"RATE_LIMITED":{"value":{"error":{"code":"RATE_LIMITED"}}}}}}},"500":{"description":"`INTERNAL`: Something went wrong on our side. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"INTERNAL":{"value":{"error":{"code":"INTERNAL"}}}}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key, sent as `Authorization: Bearer <key>`. Keys start with `mf_live_`. Owners and admins make them in the app: open API keys in the sidebar, under Workspace."}},"schemas":{"ApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"What went wrong, such as `NOT_FOUND`. Treat a code you do not know by the answer's HTTP status."},"details":{"description":"More about the error, for the codes that have it. Its shape depends on `code`.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["code"]}},"required":["error"],"description":"Every error answer has this shape."},"BatchEntryError":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The entry's place in the list, from 0."},"code":{"type":"string","description":"What is wrong, as an error code: `VALUE_INVALID`, `NOT_FOUND`, `GROUP_INVALID` or `INVALID_REQUEST`."},"columnId":{"description":"The column whose value is the problem, when it is one column's value.","type":"string"},"message":{"type":"string","description":"A plain description of the problem."}},"required":["index","code","message"],"description":"One problem with one entry of a batch."},"BatchInvalidDetails":{"type":"object","properties":{"errors":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/BatchEntryError"},"description":"One for each problem, in the order of the entries."}},"required":["errors"],"description":"The details of `BATCH_INVALID`. Nothing was written."},"BatchItemsAnswer":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"description":"The items, in the order of the entries."},"formerMembers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"The former member's user ID."},"name":{"type":"string","description":"Their name, to show in place of the ID."}},"required":["id","name"]},"description":"The people the items name who are no longer members of the workspace, with their names. Often empty."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys the items name in `createdBy` or `updatedBy`, revoked ones too. Often empty."}},"required":["items","formerMembers","apiKeys"],"description":"The items the batch created and updated."},"BatchItemsRequest":{"type":"object","properties":{"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"description":"The ID of a live or archived item of this board, to update it. Leave it out to create an item.","type":"string","pattern":"^itm_[0-9a-z]{21}$"},"name":{"description":"The item's name, 1 to 300 characters, trimmed. Needed to create an item.","type":"string","minLength":1,"maxLength":300},"values":{"description":"Values keyed by column ID, as for one create or update. A status or dropdown value may name a label or option by its exact name instead of its ID. `\"\"`, `[]` and `null` mean empty. Up to 256 KB as JSON.","type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter. `name` is kept for the Name column."},"additionalProperties":{}},"groupId":{"description":"The group to put the new item in. Left out means the board's first group. A group that is not a live group of this board makes the entry's error `GROUP_INVALID`. Only for a create: an entry with `id` cannot send it.","type":"string","pattern":"^grp_[0-9a-z]{21}$"},"position":{"description":"Where the new item goes in its group: `top` (first) or `end` (last). Left out means `end`. Only for a create: an entry with `id` cannot send it.","type":"string","enum":["top","end"]}},"additionalProperties":false},"description":"1 to 100 entries. An entry with `id` updates that item; one without creates an item. All are written or none."}},"required":["items"],"additionalProperties":false,"description":"Up to 100 creates and updates on one board."},"Board":{"type":"object","properties":{"id":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The board's ID: `brd_` and 21 characters from 0-9 and a-z."},"name":{"type":"string","description":"The board's name."},"itemWord":{"type":"string","description":"What one item is called, such as `move`."},"mainStatusColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The indexed status column, or null. A create that leaves it out gets its first status column, if any; one named on create or `PATCH`, `null` included, stays as named. While it is empty, a status column added, copied, restored or changed to status takes it."},"mainPersonColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The indexed person column, or null: a person column that holds one person. With Claim on, it is the column Claim fills."},"mainDateColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The indexed date column, or null. A create that leaves it out gets its first date column, if any; one named on create or `PATCH`, `null` included, stays as named. While it is empty, a date column added, copied, restored or changed to date takes it."},"claimEnabled":{"type":"boolean","description":"Whether members may Claim an item: put themselves in the indexed person column when it is empty."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the board was created, in UTC."},"createdBy":{"type":"string","minLength":1,"maxLength":64,"description":"Who created the board: a person's user ID, or an API key's ID when a key created it."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the board last changed, in UTC."},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"},"description":"The live columns: Name first, then the others in the board's order."},"views":{"type":"array","items":{"$ref":"#/components/schemas/View"},"description":"The board's views, in tab order."},"groups":{"default":[],"description":"The board's live groups, in the board's order. A board always has at least one, and a new board's first group is named after it. Every live item is in one of them (its `groupId`). Missing only from a replay, by its `Idempotency-Key`, of a board create first answered before boards had groups: read the board for them.","type":"array","items":{"$ref":"#/components/schemas/BoardGroup"}},"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The number of live items: not archived, not deleted."}},"required":["id","name","itemWord","mainStatusColumnId","mainPersonColumnId","mainDateColumnId","claimEnabled","createdAt","createdBy","updatedAt","columns","views","groups","itemCount"],"description":"A board with its columns, its views, its groups and its count of live items."},"BoardChangesAnswer":{"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/Change"},"description":"The board's changes after `after`, oldest first, up to `limit`. Empty when `after` is left out."},"nextPlace":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The place to pass as `after` next time: the last change's place, or your workspace's latest place when there are no changes."},"hasMore":{"type":"boolean","description":"True when `limit` cut the list and more changes are waiting. Ask again with `nextPlace`."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys that made any of these changes (`actorType` `api_key`), with their names. Revoked keys are named too."}},"required":["changes","nextPlace","hasMore","apiKeys"]},"BoardGroup":{"type":"object","properties":{"id":{"type":"string","pattern":"^grp_[0-9a-z]{21}$","description":"The group's ID: `grp_` and 21 characters from 0-9 and a-z."},"boardId":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The ID of the board the group is on."},"name":{"type":"string","description":"The group's name, 1 to 80 characters. Names need not be unique."},"color":{"type":"string","enum":["blue","purple","amber","teal","grey","coral","green","pink","red","brown"],"description":"The group's color."},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The group's place in the board's order, lowest first. Only the order means anything; the numbers can have gaps."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the group was created, in UTC."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the group was last renamed, recolored or restored, in UTC. A new order does not move it."}},"required":["id","boardId","name","color","position","createdAt","updatedAt"],"description":"One of a board's groups: a named, colored section that holds items. Every live item is in exactly one of its board's live groups."},"BoardSummary":{"type":"object","properties":{"id":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The board's ID: `brd_` and 21 characters from 0-9 and a-z."},"name":{"type":"string","description":"The board's name."},"itemWord":{"type":"string","description":"What one item is called, such as `move`."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the board was created, in UTC."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the board last changed, in UTC."}},"required":["id","name","itemWord","createdAt","updatedAt"],"description":"One board in the list of boards. Read the board for its columns and views."},"Change":{"type":"object","properties":{"place":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The change's place in the feed. Places only grow, but they have gaps: pass back the place you were given and never count from it."},"boardId":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The board the change is on."},"kind":{"type":"string","enum":["item_created","item_changed","item_archived","item_unarchived","item_deleted","item_restored","notes_edited","column_created","column_changed","column_deleted","column_restored","board_created","board_changed","board_deleted","board_restored","board_group_created","board_group_updated","board_group_reordered","board_group_deleted","board_group_restored","item_moved"],"description":"What happened: an item, column or board was created, changed, archived, deleted or restored; an item's notes were saved (`notes_edited`); a board group was created, updated, reordered, deleted or restored (`board_group_…`); or an item moved to another group or place (`item_moved`; an unarchive or restore that puts the item in the board's first group, because its own group is in the trash, writes only `item_unarchived` or `item_restored`). Skip a kind you do not know: new ones can be added."},"actorType":{"type":"string","enum":["member","api_key","automation","integration"],"description":"Who made the change: `member` for a person, `api_key` for an API key. `automation` and `integration` are kept for later."},"actorId":{"type":"string","description":"The person's user ID, or the key's ID when `actorType` is `api_key` (the answer's `apiKeys` names it)."},"itemId":{"anyOf":[{"type":"string","pattern":"^itm_[0-9a-z]{21}$","description":"An item's ID: `itm_` and 21 characters from 0-9 and a-z."},{"type":"null"}],"description":"The item that changed. Null for a column, board or group change."},"columnId":{"description":"The field that changed. For `item_changed`, the column ID, or `name` for the item's name. For a column change, the column's ID. For `board_changed`, the board field. For a group change other than `board_group_reordered`, the group's ID. Null for the other kinds.","type":["string","null"]},"oldValue":{"description":"The value before the change, as stored, or null. A column change holds the column's definition. A value emptied by a type change or a removed label stays here. `board_group_updated` and `board_group_deleted` hold the group as it was, and `board_group_deleted` adds `itemCount`, the items that went with it. `board_group_reordered` holds the old order as `{ids}`, and `item_moved` where the item was, as `{groupId, position}`.","$ref":"#/components/schemas/ChangeValue"},"newValue":{"description":"The value after the change, as stored, or null when it was emptied. `item_created` holds the new item as `{name, values, groupId, position}`; one written before groups has no `groupId` or `position`. A column change holds the column's definition. `board_group_created`, `board_group_updated` and `board_group_restored` hold the group as `{id, name, color, position}`, and `board_group_restored` adds `itemCount`, the items that came back with it. `board_group_reordered` holds the new order as `{ids}`, and `item_moved` where the item is, as `{groupId, position}`. Archive, unarchive, delete, restore and `notes_edited` hold null.","$ref":"#/components/schemas/ChangeValue"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change was made, in UTC."}},"required":["place","boardId","kind","actorType","actorId","itemId","columnId","oldValue","newValue","createdAt"],"description":"One change on a board: to an item, a column, a group or the board itself."},"ChangeValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/ChangeValue"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/ChangeValue"}}],"description":"Any JSON value: a string, number, true or false, null, a list or an object."},"Column":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","const":"name","description":"Always `name`."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"name","description":"Always `name`: the item's name. It is the item's `name` field, not a key of `values`."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"Always `{}`.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"text","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"long_text","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"number","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsNumber"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"status","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsStatus"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"dropdown","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsDropdown"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"person","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsPerson"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"date","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsDate"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"link","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"phone","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsPhone"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"email","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsEmpty"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. It never changes, even when the column is renamed."},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The column's name, 1 to 50 characters, trimmed."},"type":{"type":"string","const":"button","description":"The column's type."},"description":{"anyOf":[{"type":"string","maxLength":500,"description":"The column's description, up to 500 characters, trimmed."},{"type":"null"}],"description":"The column's description, up to 500 characters, or null."},"settings":{"description":"The column's settings: their shape depends on the type.","$ref":"#/components/schemas/ColumnSettingsButton"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the board's order: 0 for Name, which is always first, then 1 and up."}},"required":["id","name","type","description","settings","position"]}],"description":"A column of a board. `type` decides the shape of `settings` and of the column's values on items."},"ColumnSettingsButton":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":40,"description":"The button's text, 1 to 40 characters, trimmed."},"urlTemplate":{"type":"string","minLength":1,"maxLength":2000,"description":"The address the button opens, 1 to 2,000 characters, trimmed. It may name the item's fields."}},"required":["label","urlTemplate"],"additionalProperties":false,"description":"The settings of a button column. A button has no defaults: it needs both."},"ColumnSettingsDate":{"type":"object","properties":{"includeTime":{"default":false,"description":"Whether values hold a time as well as a date. Chosen when the column is created; it cannot change. Defaults to false.","type":"boolean"}},"required":["includeTime"],"additionalProperties":false,"description":"The settings of a date column."},"ColumnSettingsDateInput":{"type":"object","properties":{"includeTime":{"default":false,"description":"Whether values hold a time as well as a date. Chosen when the column is created; it cannot change. Defaults to false.","type":"boolean"}},"additionalProperties":false,"description":"The settings of a date column."},"ColumnSettingsDropdown":{"type":"object","properties":{"options":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"The options, in order, up to 100. IDs and names are unique in the column."},"multiple":{"default":false,"description":"Whether a cell may hold more than one option, up to 25.","type":"boolean"}},"required":["options","multiple"],"additionalProperties":false,"description":"The settings of a dropdown column."},"ColumnSettingsDropdownInput":{"type":"object","properties":{"options":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/LabelInput"},"description":"Every option, in order, up to 100. IDs and names are unique. An option the column has that is left out is removed from every cell that holds it."},"multiple":{"default":false,"description":"Whether a cell may hold more than one option, up to 25. Defaults to false.","type":"boolean"}},"required":["options"],"additionalProperties":false,"description":"The settings of a dropdown column in a request."},"ColumnSettingsEmpty":{"type":"object","properties":{},"additionalProperties":false,"description":"Text, long text, link and email columns, and the Name column, have no settings: `{}`."},"ColumnSettingsNumber":{"type":"object","properties":{"decimals":{"default":0,"description":"Digits shown after the point, 0 to 10. Defaults to 0.","type":"integer","minimum":0,"maximum":10},"prefix":{"default":"","description":"Text shown before the number, such as `$`, up to 10 characters. Defaults to empty.","type":"string","maxLength":10},"suffix":{"default":"","description":"Text shown after the number, such as `kg`, up to 10 characters. Defaults to empty.","type":"string","maxLength":10}},"required":["decimals","prefix","suffix"],"additionalProperties":false,"description":"The settings of a number column."},"ColumnSettingsNumberInput":{"type":"object","properties":{"decimals":{"default":0,"description":"Digits shown after the point, 0 to 10. Defaults to 0.","type":"integer","minimum":0,"maximum":10},"prefix":{"default":"","description":"Text shown before the number, such as `$`, up to 10 characters. Defaults to empty.","type":"string","maxLength":10},"suffix":{"default":"","description":"Text shown after the number, such as `kg`, up to 10 characters. Defaults to empty.","type":"string","maxLength":10}},"additionalProperties":false,"description":"The settings of a number column."},"ColumnSettingsPerson":{"type":"object","properties":{"multiple":{"default":false,"description":"Whether a cell may hold more than one person, up to 20. Defaults to false.","type":"boolean"}},"required":["multiple"],"additionalProperties":false,"description":"The settings of a person column."},"ColumnSettingsPersonInput":{"type":"object","properties":{"multiple":{"default":false,"description":"Whether a cell may hold more than one person, up to 20. Defaults to false.","type":"boolean"}},"additionalProperties":false,"description":"The settings of a person column."},"ColumnSettingsPhone":{"type":"object","properties":{"defaultCountry":{"default":null,"description":"The country the web app assumes for a number typed without `+`, as a two-letter ISO 3166 code such as `US`, or null for none. The API always takes E.164. Defaults to null.","anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["defaultCountry"],"additionalProperties":false,"description":"The settings of a phone column."},"ColumnSettingsPhoneInput":{"type":"object","properties":{"defaultCountry":{"default":null,"description":"The country the web app assumes for a number typed without `+`, as a two-letter ISO 3166 code such as `US`, or null for none. The API always takes E.164. Defaults to null.","anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"additionalProperties":false,"description":"The settings of a phone column."},"ColumnSettingsStatus":{"type":"object","properties":{"labels":{"maxItems":40,"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"The labels, in order, up to 40. IDs and names are unique in the column."}},"required":["labels"],"additionalProperties":false,"description":"The settings of a status column."},"ColumnSettingsStatusInput":{"type":"object","properties":{"labels":{"maxItems":40,"type":"array","items":{"$ref":"#/components/schemas/LabelInput"},"description":"Every label, in order, up to 40. IDs and names are unique. A label the column has that is left out is removed, and the cells that hold it are emptied."}},"required":["labels"],"additionalProperties":false,"description":"The settings of a status column in a request."},"ColumnValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/ColumnValueLink"},{"type":"null"}],"description":"A column's value. Its form depends on the column's type: text, a number, a list of IDs, a link, or `null` for empty.","x-column-types":{"text":{"$ref":"#/components/schemas/ColumnValueText"},"long_text":{"$ref":"#/components/schemas/ColumnValueLongText"},"number":{"$ref":"#/components/schemas/ColumnValueNumber"},"status":{"$ref":"#/components/schemas/ColumnValueStatus"},"dropdown":{"$ref":"#/components/schemas/ColumnValueDropdown"},"person":{"$ref":"#/components/schemas/ColumnValuePerson"},"date":{"anyOf":[{"$ref":"#/components/schemas/ColumnValueDate"},{"$ref":"#/components/schemas/ColumnValueDateTime"}]},"link":{"$ref":"#/components/schemas/ColumnValueLink"},"phone":{"$ref":"#/components/schemas/ColumnValuePhone"},"email":{"$ref":"#/components/schemas/ColumnValueEmail"}}},"ColumnValueDate":{"type":"string","format":"date","description":"A date column's value: a real calendar date written `YYYY-MM-DD`."},"ColumnValueDateTime":{"type":"string","format":"date-time","description":"The value of a date column that includes a time: a moment in UTC written `YYYY-MM-DDTHH:MM:SS.sssZ`."},"ColumnValueDropdown":{"minItems":1,"maxItems":25,"type":"array","items":{"type":"string","minLength":1,"maxLength":40},"description":"A dropdown column's value: a list of 1 to 25 option IDs, each once. A write may give an option's exact name instead of its ID. When the column's `multiple` is false, the list holds one option."},"ColumnValueEmail":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"An email column's value: an email address, up to 254 characters."},"ColumnValueLink":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri","description":"The address: `http` or `https`, up to 2,000 characters."},"text":{"description":"Text to show in place of the address, 1 to 200 characters.","type":"string","minLength":1,"maxLength":200}},"required":["url"],"additionalProperties":false,"description":"A link column's value: an address and optional text to show."},"ColumnValueLongText":{"type":"string","minLength":1,"maxLength":10000,"description":"A long text column's value: 1 to 10,000 characters."},"ColumnValueNumber":{"type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"A number column's value: a number from -1,000,000,000,000,000 to 1,000,000,000,000,000."},"ColumnValuePerson":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"A person's user ID, 1 to 64 characters."},"description":"A person column's value: a list of 1 to 20 user IDs, each once, each a current member or already in that cell. When the column's `multiple` is false, the list holds one person."},"ColumnValuePhone":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"A phone column's value: a number in international (E.164) form, `+` and 7 to 15 digits, such as `+15551234567`."},"ColumnValueStatus":{"type":"string","minLength":1,"maxLength":40,"description":"A status column's value: a label's ID. A write may give the label's exact name instead, 1 to 40 characters."},"ColumnValueText":{"type":"string","minLength":1,"maxLength":1000,"description":"A text column's value: 1 to 1,000 characters."},"FeedAnswer":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/FeedEntry"},"description":"Comments, posts and changes, newest first. Deleted comments and posts are left out."},"nextBefore":{"description":"Send it as `before` for the next page. Null at the end.","type":["string","null"]},"formerMembers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"The former member's user ID."},"name":{"type":"string","description":"Their name, to show in place of the ID."}},"required":["id","name"]},"description":"The people who wrote entries and are no longer members, with their names."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys that wrote entries, revoked ones too."}},"required":["entries","nextBefore","formerMembers","apiKeys"]},"FeedEntry":{"anyOf":[{"$ref":"#/components/schemas/Update"},{"type":"object","properties":{"kind":{"type":"string","const":"change","description":"Always `change`: an entry of the item's change log."},"id":{"type":"string","pattern":"^chg_[0-9]{1,15}$","description":"`chg_` and the change's `place`."},"actorType":{"type":"string","enum":["member","api_key","automation","integration"],"description":"Who made the change: `member`, `api_key`, `automation` or `integration`."},"actorId":{"type":"string","description":"Who made it: a person's user ID, or an API key's ID."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the change was made."},"change":{"description":"The change, as `GET /v1/items/{itemId}/changes` shows it.","$ref":"#/components/schemas/Change"}},"required":["kind","id","actorType","actorId","createdAt","change"]}],"description":"A comment, a post or a change. Read `kind` first."},"Filter":{"type":"object","properties":{"join":{"type":"string","enum":["and","or"],"description":"How the entries combine: `and` when all must match, `or` when any one is enough."},"conditions":{"maxItems":25,"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/FilterCondition"},{"$ref":"#/components/schemas/FilterGroup"}]},"description":"Conditions and condition groups. A condition has `column`; a condition group has `conditions`. Up to 25 conditions in all, those in condition groups included, and up to 5 condition groups."}},"required":["join","conditions"],"additionalProperties":false,"description":"Which items match. No conditions means no filter."},"FilterCondition":{"oneOf":[{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is"},"value":{"$ref":"#/components/schemas/FilterValue"}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is_not"},"value":{"$ref":"#/components/schemas/FilterValue"}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is_any_of"},"value":{"minItems":1,"maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/FilterValue"},"description":"1 to 25 values, each as for `is`."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is_none_of"},"value":{"minItems":1,"maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/FilterValue"},"description":"1 to 25 values, each as for `is`."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is_empty"}},"required":["column","operator"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"is_not_empty"}},"required":["column","operator"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"contains"},"value":{"type":"string","minLength":1,"maxLength":200,"description":"Text to look for, 1 to 200 characters, ignoring ASCII case."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"does_not_contain"},"value":{"type":"string","minLength":1,"maxLength":200,"description":"Text to look for, 1 to 200 characters, ignoring ASCII case."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"greater_than"},"value":{"anyOf":[{"anyOf":[{"type":"string","maxLength":200},{"type":"number"}],"description":"A label or option ID for status and dropdown, a user ID for person, text (up to 200 characters), a number, or a date as `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SS.sssZ`."},{"$ref":"#/components/schemas/FilterRelativeDate"}],"description":"A number, a date, or a relative date."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"less_than"},"value":{"anyOf":[{"anyOf":[{"type":"string","maxLength":200},{"type":"number"}],"description":"A label or option ID for status and dropdown, a user ID for person, text (up to 200 characters), a number, or a date as `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SS.sssZ`."},{"$ref":"#/components/schemas/FilterRelativeDate"}],"description":"A number, a date, or a relative date."}},"required":["column","operator","value"],"additionalProperties":false},{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to test. `name` is the Name column."},"operator":{"type":"string","const":"between"},"value":{"type":"object","properties":{"from":{"anyOf":[{"type":"string","maxLength":200},{"type":"number"}],"description":"The low end, inside the range."},"to":{"anyOf":[{"type":"string","maxLength":200},{"type":"number"}],"description":"The high end, inside the range."}},"required":["from","to"],"additionalProperties":false,"description":"A range of numbers or dates. Both ends are inside it."}},"required":["column","operator","value"],"additionalProperties":false}],"description":"One test on one column: `column`, `operator` and, except for `is_empty` and `is_not_empty`, `value`. Which operators a column takes depends on its type."},"FilterGroup":{"type":"object","properties":{"join":{"type":"string","enum":["and","or"],"description":"How the entries combine: `and` when all must match, `or` when any one is enough."},"conditions":{"minItems":1,"maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/FilterCondition"},"description":"1 to 25 conditions."}},"required":["join","conditions"],"additionalProperties":false,"description":"A condition group inside a filter, with its own `join`. It holds conditions only, not other condition groups."},"FilterMe":{"type":"object","properties":{"type":{"type":"string","const":"me"}},"required":["type"],"additionalProperties":false,"description":"Me: the member making the request. Person columns only. An API key is not a person, so a key's query that holds Me answers `QUERY_INVALID`."},"FilterRelativeDate":{"type":"object","properties":{"type":{"type":"string","const":"relative_date"},"value":{"type":"string","enum":["today","yesterday","tomorrow","this_week","last_week","next_week","this_month","last_month","last_7_days","last_30_days","next_7_days","next_30_days"],"description":"The range. Weeks start on Monday; `last_7_days` and `next_7_days` include today."}},"required":["type","value"],"additionalProperties":false,"description":"A range of days worked out when the query runs, in `timeZone`. Date columns only. `is` means inside it, `is_not` outside it, `greater_than` after its end and `less_than` before its start."},"FilterValue":{"anyOf":[{"anyOf":[{"type":"string","maxLength":200},{"type":"number"}],"description":"A label or option ID for status and dropdown, a user ID for person, text (up to 200 characters), a number, or a date as `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SS.sssZ`."},{"$ref":"#/components/schemas/FilterMe"},{"$ref":"#/components/schemas/FilterRelativeDate"}],"description":"A plain value, Me on a person column, or a relative date on a date column. Text is matched ignoring ASCII case. A day tested against a column that includes a time means that whole day in `timeZone`."},"ForbiddenDetails":{"type":"object","properties":{"reason":{"type":"string","enum":["session_required","not_a_person","workspace_not_active"],"description":"Why: `session_required` means the route is for people signed in to the app, not for API keys; `not_a_person` means the route acts as a person, such as Claim. `workspace_not_active` answers a person signed in to the app who makes a key in a workspace that is not active; a key never gets it."}},"required":["reason"]},"GroupAnswer":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/BoardGroup"}},"required":["group"],"description":"One group."},"GroupBy":{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to group by. It must hold one value: not a button, not the Name column, and not a person or dropdown column that allows several."},"direction":{"type":"string","enum":["asc","desc"],"description":"The order of the sections. The section of empty cells is always last."},"showEmpty":{"description":"True to list every label or option that no matching item has too, with a count of 0, in the column's order (reversed for `desc`). For status and dropdown columns; other types ignore it. Left out means false. It adds sections to the counts only; the items are the same.","type":"boolean"}},"required":["column","direction"],"additionalProperties":false,"description":"Group by: puts the items in sections by one column's value, in a direction of its own. Not the board's groups, which every item is in."},"GroupCount":{"type":"object","properties":{"key":{"description":"What names the section. Under a column grouping (`groupsKind` `column`): a label or option ID, a user ID, lower-cased text, a number, a date bucket (`earlier`, `last_week`, `earlier_this_week`, `yesterday`, `today`, `tomorrow`, `later_this_week`, `next_week`, `later`), or null for empty cells. Under the board's groups (`groupsKind` `board`): the group's ID.","type":["string","number","null"]},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matching items in the section, on the whole board."}},"required":["key","count"],"description":"One section, a value of the grouped column or one of the board's groups, and how many matching items it holds."},"GroupCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"The group's name, 1 to 80 characters, trimmed. Names need not be unique."},"color":{"description":"The group's color. Left out, the group takes the color that the fewest of the board's live groups use, the first in the list on a tie.","type":"string","enum":["blue","purple","amber","teal","grey","coral","green","pink","red","brown"]},"before":{"description":"A live group of this board to put the new group right before. Left out, the group goes last. Any other group answers 400 `GROUP_INVALID` with `details.field` `before`.","type":"string","pattern":"^grp_[0-9a-z]{21}$"}},"required":["name"],"additionalProperties":false,"description":"A new group: a name and, if you like, a color and a place."},"GroupDeleteAnswer":{"type":"object","properties":{"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of the group's live items went to the trash with it. Archived items are not counted: they stay archived."}},"required":["itemCount"],"description":"How many items went to the trash with the group."},"GroupInvalidDetails":{"type":"object","properties":{"field":{"type":"string","const":"before","description":"The field at fault: `before`, the group a new group was to go right before."}},"required":["field"]},"GroupOrderRequest":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^grp_[0-9a-z]{21}$"},"description":"Every live group of the board, each once, in the order to show. Any other list (a group missing, extra, repeated, deleted or of another board) answers 409 `GROUP_ORDER_MISMATCH`."}},"required":["ids"],"additionalProperties":false,"description":"The board's groups in their new order."},"GroupRestoreAnswer":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/BoardGroup"},"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many items came back with the group: the ones that went to the trash with it and were still there. An item sent to the trash on its own stays there."}},"required":["group","itemCount"],"description":"The group, back in the board's order, and how many items came back with it."},"GroupUpdateRequest":{"type":"object","properties":{"name":{"description":"A new name, 1 to 80 characters, trimmed.","type":"string","minLength":1,"maxLength":80},"color":{"description":"A new color.","type":"string","enum":["blue","purple","amber","teal","grey","coral","green","pink","red","brown"]}},"additionalProperties":false,"description":"The fields to change. Send at least one of `name` and `color`."},"GroupsAnswer":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/BoardGroup"},"description":"The board's live groups, in the board's order."}},"required":["groups"],"description":"A board's live groups, in order."},"InvalidRequestDetails":{"type":"object","properties":{"reason":{"type":"string","enum":["unknown_column","wrong_type","include_time_locked","main_person_single","same_type","settings_invalid","settings_required","order_mismatch","last_view"],"description":"Why: `unknown_column` or `wrong_type` (the column `field` names is missing or of the wrong type), `include_time_locked` (a date column's `includeTime` cannot change), `main_person_single` (the person column Claim assigns must hold one person), `same_type`, `settings_invalid` or `settings_required` (a type change), `order_mismatch` (a column order that is not every column once) or `last_view` (a board keeps at least one view)."},"field":{"description":"The field at fault, such as `statusColumnId` or `afterColumnId`, when the reason is about one field.","type":"string"}},"required":["reason"]},"Item":{"type":"object","properties":{"id":{"type":"string","pattern":"^itm_[0-9a-z]{21}$","description":"The item's ID: `itm_` and 21 characters from 0-9 and a-z."},"boardId":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The ID of the board the item is on."},"groupId":{"type":"string","pattern":"^grp_[0-9a-z]{21}$","description":"The ID of the item's group. A live item is always in one of the board's `groups`. An archived item keeps its group even when that group is deleted later; unarchive then puts it at the end of the board's first group."},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The item's place in its group: a whole number, lowest first. Only the order means anything, and the item ID breaks a tie. It can be negative."},"name":{"type":"string","description":"The item's name: the board's Name column."},"values":{"$ref":"#/components/schemas/ItemValues"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the item was created, in UTC."},"createdBy":{"type":"string","minLength":1,"maxLength":64,"description":"Who created it: a person's user ID or an API key's ID. `createdByType` says which."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the item last changed, in UTC."},"updatedBy":{"type":"string","minLength":1,"maxLength":64,"description":"Who changed it last: a person's user ID or an API key's ID. `updatedByType` says which."},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the item was archived. Null when it is not archived."},"createdByType":{"type":"string","enum":["member","api_key"],"description":"Whether `createdBy` is a person (`member`) or an API key (`api_key`)."},"updatedByType":{"type":"string","enum":["member","api_key"],"description":"Whether `updatedBy` is a person (`member`) or an API key (`api_key`)."}},"required":["id","boardId","groupId","position","name","values","createdAt","createdBy","updatedAt","updatedBy","archivedAt","createdByType","updatedByType"],"description":"An item on a board: its name, its values by column ID, its group and place in it, and who made and changed it."},"ItemAnswer":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/Item"},"formerMembers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"The former member's user ID."},"name":{"type":"string","description":"Their name, to show in place of the ID."}},"required":["id","name"]},"description":"The people the item names who are no longer members of the workspace, with their names, so they can be shown. Often empty."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys the item names in `createdBy` or `updatedBy`, revoked ones too. Often empty."}},"required":["item","formerMembers","apiKeys"],"description":"One item, with the former members and API keys it names."},"ItemChangesAnswer":{"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/Change"},"description":"The item's changes, newest first, up to `limit`."},"nextBefore":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The place to pass as `before` to read older changes, or null when there are no more."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys that made any of these changes (`actorType` `api_key`), with their names. Revoked keys are named too."}},"required":["changes","nextBefore","apiKeys"]},"ItemCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":300,"description":"The item's name, 1 to 300 characters, trimmed."},"values":{"description":"The item's values, keyed by column ID. A status or dropdown value may name a label or option by its exact name instead of its ID. `\"\"`, `[]` and `null` mean empty. Up to 256 KB as JSON.","type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter. `name` is kept for the Name column."},"additionalProperties":{}},"groupId":{"description":"The group to put the new item in. Left out means the board's first group. A group that is not a live group of this board answers 400 `GROUP_INVALID`.","type":"string","pattern":"^grp_[0-9a-z]{21}$"},"position":{"description":"Where the new item goes in its group: `top` (first) or `end` (last). Left out means `end`.","type":"string","enum":["top","end"]}},"required":["name"],"additionalProperties":false,"description":"A new item: a name and, if you like, values, a group and a place in it."},"ItemMoveRequest":{"type":"object","properties":{"groupId":{"description":"The group to move the item to: a live group of the item's board. Left out means the item's own group, or the board's first group when its own was deleted. Any other group answers 400 `GROUP_INVALID`.","type":"string","pattern":"^grp_[0-9a-z]{21}$"},"position":{"description":"Where the item goes in the group: `top` (first) or `end` (last). Left out means `top`.","type":"string","enum":["top","end"]}},"additionalProperties":false,"description":"Where to move the item: a group, and its top or its end. An empty body, or none, moves the item to the top of its own group."},"ItemUpdateRequest":{"type":"object","properties":{"name":{"description":"A new name, 1 to 300 characters, trimmed.","type":"string","minLength":1,"maxLength":300},"values":{"description":"The values to set, keyed by column ID. Each value sent is set whole; a column left out stays as it is. A status or dropdown value may name a label or option by its exact name instead of its ID. `\"\"`, `[]` and `null` mean empty. Up to 256 KB as JSON.","type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID: 1 to 40 lowercase letters, digits and underscores, starting with a letter. `name` is kept for the Name column."},"additionalProperties":{}}},"additionalProperties":false,"description":"The fields to change. Send at least one of `name` and `values`. It does not change the item's group: moving is `POST /v1/items/{itemId}/move`."},"ItemValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/ColumnValue"},"description":"The item's values, keyed by column ID. Only the board's live columns appear. A missing key and `null` both mean empty. The shape of a value depends on its column's type."},"ItemsQueryAnswer":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"description":"The page of items. Values hold the board's live columns only."},"nextCursor":{"description":"Send it as `cursor` for the next page. Only null means the end: a short or empty page can still have a next one.","type":["string","null"]},"formerMembers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"The former member's user ID."},"name":{"type":"string","description":"Their name, to show in place of the ID."}},"required":["id","name"]},"description":"The people the items name who are no longer members of the workspace, with their names. Often empty."},"count":{"description":"The matching items on the whole board, not the page. Only with `counts: true`. `groupIds` does not narrow it.","type":"integer","minimum":0,"maximum":9007199254740991},"groups":{"description":"The sections and their counts. Only with `counts: true`, in a query with a column grouping or the `groups` layout; `groupsKind` says which. A column grouping lists each section that has matching items, in the grouping's order, the empty section last; with `showEmpty`, every label or option no item has too, with a count of 0. The `groups` layout lists every live group of the board in the board's order, a group with no match at 0. `groupIds` does not narrow it.","type":"array","items":{"$ref":"#/components/schemas/GroupCount"}},"groupsKind":{"description":"What the keys of `groups` name: `column`, the sections of a column grouping; `board`, the board's groups (the `groups` layout with no column grouping). It comes with `groups` and only then.","type":"string","enum":["board","column"]},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API keys the items name in `createdBy` or `updatedBy`, revoked ones too. Often empty."}},"required":["items","nextCursor","formerMembers","apiKeys"],"description":"A page of items, with the cursor for the next page."},"ItemsQueryRequest":{"type":"object","properties":{"view":{"description":"A saved view's ID. It stands in for `filter`, `sort` and `group`, so they cannot be sent with it; `search`, `archived`, `layout` and `groupIds` can. With a view, `layout` left out is `groups` for a table view with no column grouping and `flat` otherwise. Parts of the view that no longer fit the board's columns are left out.","type":"string","pattern":"^viw_[0-9a-z]{21}$"},"filter":{"description":"Which items to include. Left out or null means all.","anyOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}]},"sort":{"description":"The order. Left out or empty means creation order, or in the `groups` layout the items' `position` in each group. In the `groups` layout a sort applies inside each group.","$ref":"#/components/schemas/Sort"},"group":{"description":"Group by: puts the items in sections by one column's value. Left out or null means none. This is not the board's groups: for those, use the `groups` layout.","anyOf":[{"$ref":"#/components/schemas/GroupBy"},{"type":"null"}]},"search":{"description":"One phrase, up to 200 characters, looked for in the item's name and its text, long text, link, phone and email values, ignoring ASCII case. Trimmed; left out, null or empty means no search.","anyOf":[{"type":"string","maxLength":200,"description":"One phrase, up to 200 characters."},{"type":"null"}]},"archived":{"description":"True for archived items instead of live ones. Left out means live items.","type":"boolean"},"layout":{"description":"How the items are laid out when there is no column grouping. `flat`: the sort, then creation order. `groups`: the board's order, group by group in the order of the board's `groups`, and inside each group the sort, or the items' `position` when there is no sort, then the ID. Left out means `flat`, except for a view (see `view`). A column grouping decides the sections and `layout` is ignored; archived items (`archived: true`) are always one flat list.","type":"string","enum":["flat","groups"]},"groupIds":{"description":"Only the items of these board groups: 1 to 50 group IDs, each once. Left out means every group. An ID that names no live group of the board matches nothing. A list in which no ID is a live group answers 500 `INTERNAL` today, a known bug, unless a filter, a search, `archived: true` or the `groups` layout applies too; then it answers no items. It narrows the items only: `count` and `groups` still cover every group.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^grp_[0-9a-z]{21}$"}},"limit":{"default":100,"type":"integer","minimum":1,"maximum":1000,"description":"Items per page, 1 to 1,000; 100 if left out. It may change between pages."},"cursor":{"type":"string","minLength":1,"maxLength":2048,"description":"The `nextCursor` of the last page, passed back unread. It works only with the query it came from, and never expires. Up to 2,048 characters."},"timeZone":{"description":"An IANA time zone name, such as `Europe/Berlin`, for relative dates and the buckets of a Group by on a date column. Left out means UTC.","type":"string","minLength":1,"maxLength":64},"counts":{"default":false,"description":"True to get `count`, and `groups` and `groupsKind` in a query with a column grouping or the `groups` layout. Counting can read the whole board.","type":"boolean"}},"additionalProperties":false,"description":"A saved view, or a filter, sort, Group by and search, with a layout, a page size, a cursor and a time zone."},"Label":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]{0,39}$","description":"The label's ID. It stays when the label is renamed."},"name":{"type":"string","minLength":1,"maxLength":40,"description":"The label's name, 1 to 40 characters, trimmed. Unique in its column: a write may give a label by its exact name."},"color":{"type":"string","enum":["blue","purple","amber","teal","grey"],"description":"The label's color."}},"required":["id","name","color"],"additionalProperties":false,"description":"A status label or dropdown option."},"LabelInput":{"type":"object","properties":{"id":{"description":"The ID of a label the column has, to keep it. Left out, it is a new label and the API makes its ID.","type":"string","pattern":"^[a-z0-9][a-z0-9_]{0,39}$"},"name":{"type":"string","minLength":1,"maxLength":40,"description":"The label's name, 1 to 40 characters, trimmed. Unique in its column: a write may give a label by its exact name."},"color":{"type":"string","enum":["blue","purple","amber","teal","grey"],"description":"The label's color."}},"required":["name","color"],"additionalProperties":false,"description":"A status label or dropdown option in a request."},"LimitReachedDetails":{"type":"object","properties":{"limit":{"type":"string","description":"What is full: `columns` or `views` (per board), `groups` (live groups per board, on a group create or restore), `conversion-values` (the values one type change would convert) or `conversion-bytes` (their size)."},"max":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The cap."}},"required":["limit","max"]},"Member":{"type":"object","properties":{"id":{"type":"string","description":"The membership's ID. A person column takes `userId`, not this."},"userId":{"type":"string","description":"The person's user ID: what a person column holds, and the `actorId` of the changes they make."},"name":{"type":"string","description":"The person's name. Can be empty."},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The person's email address."},"role":{"type":"string","enum":["owner","admin","member"],"description":"The person's role in the workspace: `owner`, `admin` or `member`."},"isYou":{"type":"boolean","description":"True for the signed-in person reading the list. Always false for an API key."}},"required":["id","userId","name","email","role","isYou"],"description":"A person in the workspace."},"MembersAnswer":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"},"description":"The workspace's members, owner first, then by when they joined."},"seats":{"type":"object","properties":{"used":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Seats in use: the members plus the invitations still waiting."},"limit":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The most seats the workspace can use, or null for no limit."}},"required":["used","limit"],"description":"The workspace's seats."},"invitations":{"description":"The invitations still waiting, oldest first. Only for owners and admins signed in to the app: an API key's answer never has it.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The invitation's ID."},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The address it was sent to."},"role":{"type":"string","enum":["admin","member"],"description":"The role the person gets on joining: `admin` or `member`."},"sentAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was sent, in UTC."},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it stops working, in UTC."}},"required":["id","email","role","sentAt","expiresAt"]}}},"required":["members","seats"]},"NamedApiKey":{"type":"object","properties":{"id":{"type":"string","pattern":"^apk_[0-9a-z]{21}$","description":"The key's ID: `apk_` and 21 characters. Never the key itself."},"name":{"type":"string","description":"The name the key was given."},"revoked":{"type":"boolean","description":"True when the key was revoked. What it did stays."}},"required":["id","name","revoked"],"description":"An API key that an answer names, so its name can be shown."},"Note":{"type":"object","properties":{"markdown":{"type":"string","description":"The notes, in Markdown. Empty when none are saved."},"version":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Raised by one on each save; 0 when none are saved. Send it as `baseVersion` to save."},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the notes were last saved. Null when none are saved."},"updatedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"description":"A person's user ID, 1 to 64 characters."},{"type":"null"}],"description":"Who saved last: a person's user ID or an API key's ID. Null when none are saved."},"updatedByType":{"anyOf":[{"type":"string","enum":["member","api_key"],"description":"`member` for a person, `api_key` for an API key."},{"type":"null"}],"description":"Whether `updatedBy` is a person (`member`) or an API key (`api_key`). Null when none are saved."},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/NamedApiKey"},"description":"The API key named by `updatedBy`, when a key saved last; otherwise empty."}},"required":["markdown","version","updatedAt","updatedBy","updatedByType","apiKeys"]},"NotesConflictDetails":{"type":"object","properties":{"note":{"description":"The notes as they are now, with their current `version`.","$ref":"#/components/schemas/Note"}},"required":["note"]},"PayloadTooLargeDetails":{"type":"object","properties":{"limit":{"type":"string","const":"notes","description":"What is too long: `notes`, the Markdown of an item's notes."},"max":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The most characters allowed."}},"required":["limit","max"]},"QueryInvalidDetails":{"type":"object","properties":{"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"description":"Where in the query, as keys and indexes from the top: `filter`, `conditions`, `0`, `column`."},"code":{"type":"string","description":"What is wrong there, such as `not_groupable`. Read codes you do not know as invalid."},"message":{"type":"string","description":"A short note for a person reading the error."}},"required":["path","code","message"]},"description":"One entry for each problem in the query."}},"required":["issues"]},"Sort":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/SortLevel"},"description":"Up to 5 levels, the first the main key, each column once. The item ID breaks ties. Empty means creation order."},"SortLevel":{"type":"object","properties":{"column":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column ID to sort by. `name` is the Name column. A button column cannot be sorted."},"direction":{"type":"string","enum":["asc","desc"],"description":"`asc` for ascending, `desc` for descending."}},"required":["column","direction"],"additionalProperties":false,"description":"One level of a sort."},"Update":{"type":"object","properties":{"kind":{"type":"string","enum":["comment","post"],"description":"`comment` when a member wrote it, `post` when an API key did."},"id":{"type":"string","pattern":"^upd_[0-9a-z]{21}$","description":"The update's ID."},"actorType":{"type":"string","enum":["member","api_key","automation","integration"],"description":"Who wrote it: `member` for a comment, `api_key` for a post."},"actorId":{"type":"string","description":"The writer's ID: a person's user ID, or the API key's ID."},"body":{"type":"string","description":"The text, plain and trimmed."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was written."},"editedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When its author last changed the text. Null until then."}},"required":["kind","id","actorType","actorId","body","createdAt","editedAt"]},"ValueInvalidDetails":{"type":"object","properties":{"columnId":{"type":"string","description":"The column whose value was refused."},"reason":{"description":"Why: `invalid` (wrong type or form), `unknown_label`, `unknown_option`, `unknown_person` (not a current member) or `too_large`.","type":"string","enum":["invalid","unknown_label","unknown_option","unknown_person","too_large"]},"message":{"description":"A short note for a person reading the error.","type":"string"}},"required":["columnId"]},"View":{"type":"object","properties":{"id":{"type":"string","pattern":"^viw_[0-9a-z]{21}$","description":"The view's ID: `viw_` and 21 characters from 0-9 and a-z."},"boardId":{"type":"string","pattern":"^brd_[0-9a-z]{21}$","description":"The ID of the board the view belongs to."},"name":{"type":"string","description":"The view's name, up to 40 characters."},"type":{"type":"string","enum":["table","kanban"],"description":"`table` or `kanban`. It never changes."},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The view's place in the board's tab order, lowest first. The numbers can have gaps."},"config":{"$ref":"#/components/schemas/ViewConfig"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the view was made, in ISO 8601 (UTC)."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the view's name or settings were last written, in ISO 8601 (UTC). Every `PATCH` moves it, even one that changes nothing; a new order does not."}},"required":["id","boardId","name","type","position","config","createdAt","updatedAt"],"description":"A saved way to show a board's items, as a Table or a Kanban, with its own settings. Views are shared by everyone in the workspace, and the last write wins."},"ViewConfig":{"type":"object","properties":{"filter":{"description":"The view's saved filter, the same shape as the items query's `filter`. Null means none.","anyOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}]},"sort":{"description":"The view's saved sort, the same shape as the items query's `sort`. Empty means none.","$ref":"#/components/schemas/Sort"},"group":{"description":"The view's saved Group by, the same shape as the items query's `group`. Null means none. Name cannot be grouped by (400 `GROUPING_NOT_ALLOWED`); a Group by on Name saved before that stays as it is, and the view runs as if it had none.","anyOf":[{"$ref":"#/components/schemas/GroupBy"},{"type":"null"}]},"statusColumnId":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"A column's ID, `name` for the Name column included."},{"type":"null"}],"description":"The status column a Kanban view groups its cards by: a live status column of the board, or null. Null means the view has not picked one; the app then uses the board's indexed status column, then its first status column. A Table view ignores it."},"columns":{"maxItems":61,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"The column's ID. `name` is the Name column."},"hidden":{"type":"boolean","description":"True hides the column in this view. The Name column cannot be hidden."},"width":{"anyOf":[{"type":"integer","minimum":48,"maximum":1200},{"type":"null"}],"description":"The column's width in pixels, 48 to 1,200. Null is the default width."},"wrap":{"type":"boolean","description":"True wraps long text in the column's cells."}},"required":["id","hidden","width","wrap"],"additionalProperties":false,"description":"How one column shows in the view."},"description":"How each column shows, in the order shown: up to 61 entries (the board's 60 columns and Name), each column once, and only columns the board has. A board column left out shows after the listed ones, visible, at the default width."},"openIn":{"type":"string","enum":["panel","page"],"description":"Whether items open in the side panel (`panel`, the default) or as a full page (`page`). Stored; it has no effect yet."}},"required":["statusColumnId","columns","openIn"],"additionalProperties":false,"description":"A view's settings: its saved filter, sort and Group by, a Kanban view's status column, the column layout, and where items open."}}}}