--- title: "The document's Plan boards, in tab then canvas order, with their columns; the statuses they name, each once with its column name; and the card types. A tab-scoped link passes tabId and gets that tab's boards." method: GET path: "/documents/{id}/plan" tags: ["Items"] --- # The document's Plan boards, in tab then canvas order, with their columns; the statuses they name, each once with its column name; and the card types. A tab-scoped link passes tabId and gets that tab's boards. `GET /documents/{id}/plan` ## Request - Base URL: `https://www.livediagram.app/api` - URL: `https://www.livediagram.app/api/documents/{id}/plan` - Auth: one of: - HTTP bearer - API key in header `X-Owner-Id` ## Path parameters - `id` string, required ## Query parameters - `tabId` string ## Response `200` Success. - PlanResponse - `boards` PlanBoardOutline[], required - `columns` PlanColumnOutline[], required - `name` string, required - `status` string, required - `wipLimit` number - `elementId` string, required - `kind` 'board' | 'all-cards' | 'archive', required - `tabId` string, required - `tabName` string, required - `title` string, required - `types` string[], nullable, required - `itemTypesRev` number, required - `statuses` PlanStatusName[], required - `name` string, required - `status` string, required - `tabs` PlanTabOutline[] - `id` string, required - `kind` string, required - `name` string, required - `sheetIds` string[] - `theme` string - `types` ItemTypeDef[], required - `color` string, required - `custom` CustomFieldDef[] - `currency` string - `id` string, required - `kind` 'text' | 'longtext' | 'number' | 'currency' | 'date' | 'checkbox' | 'link' | 'email' | 'choice' | 'multichoice' | 'rating' | 'card', required - `label` string, required - `linkType` string - `onCard` boolean - `options` string[] - `scale` number - `defaultStatus` string - `detailsLabel` string - `display` object - `compact` object - `body` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `foot` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `footEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `head` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `headEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `lead` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `row` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `trail` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `detailed` object - `body` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `foot` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `footEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `head` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `headEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `lead` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `row` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `trail` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `minimal` object - `body` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `foot` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `footEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `head` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `headEnd` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `lead` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `row` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `trail` CardField[] - union - 'key' - 'type' - 'assignee' - 'priority' - 'labels' - 'estimate' - 'start' - 'due' - 'votes' - 'checklist' - 'comments' - 'description' - string - `excludedStatuses` string[] - `fields` string[], required - `glyph` union, required - 'task' | 'story' | 'bug' | 'project' | 'action' | 'epic' | 'milestone' | 'release' | 'ticket' | 'kanban' | 'checklist' | 'inbox' | 'person' | 'team' | 'user-plus' | 'user-check' | 'contact' | 'crown' | 'chat' | 'mail' | 'phone' | 'megaphone' | 'bell' | 'send' | 'video' | 'at' | 'calendar' | 'flag' | 'clock' | 'target' | 'pin' | 'hourglass' | 'repeat' | 'note' | 'idea' | 'bookmark' | 'book' | 'document' | 'pencil' | 'lightbulb' | 'puzzle' | 'quote' | 'star' | 'heart' | 'risk' | 'shield' | 'lock' | 'eye' | 'fire' | 'sparkle' | 'info' | 'question' | 'ban' | 'trophy' | 'coin' | 'chart' | 'trend' | 'briefcase' | 'cart' | 'building' | 'percent' | 'wallet' | 'cube' | 'gift' | 'wrench' | 'code' | 'laptop' | 'database' | 'cloud' | 'globe' | 'home' | 'key' | 'leaf' | 'link' - 'item' - `id` string, required - `label` string, required - `newTitle` string, required - `tabs` ItemTypeTab[] - `fields` string[], required - `id` string, required - `label` string, required ## Other responses - `401`: Error. - `403`: Error. - `404`: Error. - `405`: Error. - `410`: Error. - `429`: Rate limited. Back off and retry. --- [API](https://skmtc.dev/livediagram/apis/livediagram-api.md) · [All operations](https://skmtc.dev/livediagram/apis/livediagram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/livediagram/apis/livediagram-api/revisions/f286d27acfd2?raw)