Return the authenticated HacknPlan user (id, username, email, name). Use first to confirm the API key works.

List HacknPlan workspaces visible to the API key. NOTE: Personal/Personal-Plus accounts return an empty list even though a 'Personal workspace' exists in the web UI — projects still work and are auto-assigned to it. Only Studio workspaces appear here.

List all HacknPlan projects.

Get one project with its stages, categories, importance levels and boards rolled up — the structural overview you need before creating work items.

List a project's stages (kanban columns). status is created|started|completed.

List a project's work-item categories.

List a project's tags.

List a project's boards (sprints/kanban boards). The default is 'Sprint 1'. Closed boards are hidden unless include_closed=true.

List a project's milestones (release/epic groupings). Closed milestones are hidden unless include_closed=true.

List/search a project's work items with server-side filters. All filters are optional and AND-combined: board_id, stage_id, category_id, milestone_id, importance_level_id, tag_id, design_element_id, assigned_user_id, is_story, status ('open'|'closed'), text (free-text match). Paginated via limit/offset. For a forgiving name-based search that also works if a filter is unsupported, use find_work_items.

Get one work item with its sub-tasks (checklist) and comments.

Create a project. cost_metric is the STRING "Hours" or "Points" (capitalized). workspaceId is auto-assigned to your personal workspace (echoed back as 0). Returns the new project.

Create a kanban stage. status must be one of (lowercase): created | started | completed. Both color AND icon are required by the API (omitting icon returns HTTP 500); icon is a HacknPlan icon name (e.g. inbox, wrench, check, rocket, eye, ban).

Create a work-item category.

Create a tag (label).

Create a milestone. due_date is ISO 8601 (e.g. '2026-06-30T00:00:00Z').

Create a work item (task or user story). Required: title + importance_level_id (get it from get_project/list_*). category_id is required for tasks (not user stories). parent_id nests this item under a user story (the story→task hierarchy). assigned_user_ids assigns members; dependency_ids makes it blocked-by those items. sub_tasks is a list of checklist item titles. due_date/start_date are ISO 8601. If stage_id is given, the item is moved to that stage after creation (the API always creates new items in the default/first stage).

Partially update a work item: move stage, retitle, edit description, set start/due date, block/unblock, retag, re-prioritize (importance_level_id), recategorize (category_id), re-estimate (estimated_cost), move board/milestone, re-parent, or reassign (assigned_user_ids replaces the whole assignee set). Provide only the fields you want to change.

Add one sub-task (checklist item) to a work item.

Add a comment to a work item (markdown supported, max 5000 chars).

Delete a work item. Destructive — set confirm=true to proceed.

Delete an ENTIRE project and everything in it. Destructive — set confirm=true.

Update a kanban stage (re-name / re-color / re-icon / change status). status: created | started | closed (lowercase). color is hex; icon is a HacknPlan icon name (e.g. inbox, wrench, check, rocket, eye, ban).

Delete a stage. Destructive (a project needs >=3 stages, one per status). confirm=true required.

Update a work-item category (re-name / re-color / re-icon).

Delete a work-item category. Destructive. confirm=true required. (Useful to remove the game-dev defaults — Audio, Narrative, etc.)

Update a tag (re-name / re-color / re-icon / toggle icon-only display).

Delete a tag. Destructive (removes it from all work items). confirm=true required.

List a project's importance/priority levels (Urgent/High/Normal/Low by default).

Create an importance/priority level (color+icon).

Update an importance level (re-name / re-color / re-icon / set default).

Attach an existing tag to a work item.

Remove a tag from a work item.

Assign a project user to a work item.

Remove a user assignment from a work item.

List the members of a project (id, username).

List a work item's sub-tasks (its checklist), with completion state.

Update a sub-task (rename and/or mark complete/incomplete).

Delete a sub-task. confirm=true required.

List a work item's dependencies (the predecessors that block it).

Make work_item_id depend on (be blocked by) predecessor_id. The successor can't be completed until the predecessor is done.

Remove a dependency from a work item. confirm=true required.

List the work logs (time entries) on a work item.

Log time/effort on a work item. value = amount worked, in the project's costMetric unit (hours or points). comment is an optional note. Logs can only be edited within ~1 hour of creation.

List the design-element TYPES (node categories of the design model, e.g. System / Module / Feature). Repurpose as a feature-tree taxonomy.

Create a design-element type (a node category for the design/feature tree).

List design elements (nodes of the design/feature/knowledge tree). Optionally filter by type_id.

Get one design element (with its documentation/description).

Create a design element (a node in the design/feature tree). type_id is a design-element type id; parent_id nests it under another element (omit for a root). Link work items to it so progress rolls up the tree.

Update a design element (rename, edit documentation, re-parent, change type). type_id and name are required by the API; pass the element's current values to keep them. Use get_design_element first to read them.

Delete a design element (and its sub-tree). Destructive. confirm=true required.

Create a board (sprint/iteration). Optionally nest under a milestone and set start/due dates (ISO 8601).

Close (end) a board/sprint.

Update a project's name / description / cost metric ("Hours" or "Points").

Get a project's metrics (completion %, totals) — analytics Trello lacks.

Get a milestone's metrics (burndown / completion).

List the attachments on a work item.

ALL-PROJECTS birds-eye view — the cross-project portfolio dashboard HacknPlan has no native equivalent for. Rolls up every project: completion %, open/closed counts, and urgent / blocked / due-soon / overdue flags, grouped via HACKNPLAN_GROUPS. Use for 'how's everything doing', 'what's on fire across all projects', 'portfolio status'.

ALL-PROJECTS deadline countdown — every work item that has a due date, across every project, bucketed by time horizon (Overdue / This week ≤7d / Next 2 weeks 8-14d / This month 15-30d / Later) with a live days-left countdown. Use for 'what's due soon', 'what's overdue', 'deadlines', 'what should I do this week'.

Search a project's work items by free text and/or facets — the name-based lookup that saves chaining list→scan→act. query matches title or description (case-insensitive). Optional facet filters: importance (level name e.g. 'Urgent'), tag (name), stage (name). status: open|closed|all (default open). Use this to resolve a task you only know by name into its id before update_work_item / move / etc.

List work items assigned to the authenticated user (from /users/me), optionally scoped to one project — the 'what am I working on' / standup view. By default only open items; set include_closed=true to see finished ones too. Relies on the assignee data the list endpoint returns inline.

Break a feature down in ONE call: create a user story, then create its child tasks (parented to the story) — optionally each with its own checklist (sub_tasks). Tasks inherit importance_level_id, default_category_id, board_id and milestone_id unless overridden per task. This is the fast path for 'turn this feature into a story with tasks'. Returns the created story and tasks.

Update a milestone (rename, change due/start date, edit general info). Dates are ISO 8601.

Delete a milestone. Destructive (work items are un-grouped, not deleted). confirm=true required.

Update a board/sprint (rename, change start/due date, description, or re-nest under a milestone). Dates are ISO 8601.

Close (archive) a project without deleting it — its work items and history are preserved. Reverse with reopen_project.

Reopen a previously closed/archived project.

Close (release) a milestone — marks it done without deleting it. Reverse with reopen_milestone.

Reopen a previously closed milestone.

Reopen a previously closed board/sprint (counterpart to close_board).

Project activity/event feed — the 'what changed' / standup view. Returns events between from and to (ISO 8601 dates/timestamps). If from is omitted it defaults to 7 days ago, to to now. Use for 'what happened this week', 'recent changes', daily standups.

Get a board's (sprint's) metrics — burndown / velocity / completion. Optionally scope to one user via user_id.

Get a design element's metrics (work rolled up from items linked to it). include_children rolls up its whole sub-tree.

List the comments/notes on a design element (design-doc discussion thread).

Add a comment/note to a design element (markdown supported, max 5000 chars).