Developer API

Build on Planiq

A complete REST API covering everything you can do in the Planiq UI — board creation, nodes, edges, sub-boards, attachments, time tracking, members, chat, and activities. Authenticate with a single API key.

Get started Read the spec

Get started in three steps

01
Create an API key
Sign in and open your profile. Under "Developer / API keys" pick a label and click Create — the full token is shown exactly once.
02
Send the bearer token
Every request carries Authorization: Bearer pq_live_... The token resolves to your user, with the same permissions you have in the UI.
03
Call the API
Start with POST /api/v1/boards to create a board, then drive it with the granular node, edge, and chat endpoints below.

First requests

# List your boards
curl https://planiq.cloud/api/v1/boards \
  -H "Authorization: Bearer pq_live_…"

# Create a board
curl -X POST https://planiq.cloud/api/v1/boards \
  -H "Authorization: Bearer pq_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"My new board"}'

# Add a node as a child of an existing one
curl -X POST https://planiq.cloud/api/v1/boards/{BOARD_ID}/nodes \
  -H "Authorization: Bearer pq_live_…" \
  -H "Content-Type: application/json" \
  -d '{"label":"Pick a domain name","parentId":"__start__"}'

# Or insert a node on an existing edge (A → new → B)
curl -X POST https://planiq.cloud/api/v1/boards/{BOARD_ID}/nodes \
  -H "Authorization: Bearer pq_live_…" \
  -H "Content-Type: application/json" \
  -d '{"label":"Review draft","onEdgeId":"{EDGE_ID}"}'

Authentication

Both credential types resolve to the same user identity, so existing per-board permissions (viewer / editor / admin / owner) apply unchanged.

API key — Long-lived bearer token created in /profile. Recommended for integrations. Send as Authorization: Bearer pq_live_…
JWT — 7-day session token from POST /api/auth/login. Used by the web UI itself.

Use it with Claude Code (or any LLM agent)

Drop our SKILL.md into your Claude Code skills directory, then prompt in plain English — "add a task 'Pick a domain' to my Launch Plan board" — and let the agent figure out the API calls. The skill bundles the auth model, the cell-based coordinate system, the special start/end nodes, and a curated reference for the endpoints an agent will actually use.

Install

Download SKILL.md

mkdir -p ~/.claude/skills/planiq-api
curl -o ~/.claude/skills/planiq-api/SKILL.md \
  https://planiq.cloud/skills/planiq-api/SKILL.md

export PLANIQ_API_URL="https://planiq.cloud"
export PLANIQ_API_TOKEN="pq_live_…"

Both environment variables are required. Generate the API token under Developer / API keys in your profile.

API reference

Every endpoint documented below is read-only here — to try a call, copy the cURL example into your terminal.

Base URL https://planiq.cloud/api/v1 · every request needs an Authorization: Bearer pq_live_… header.

Boards

GET/api/v1/boardsList boards you can access
POST/api/v1/boardsCreate a board
GET/api/v1/boards/{id}Fetch a board with its full graph
PUT/api/v1/boards/{id}Replace a board’s graph
DELETE/api/v1/boards/{id}Delete a board

Nodes

GET/api/v1/boards/{id}/nodesList a board’s nodes
POST/api/v1/boards/{id}/nodesAdd a node as a child or on an edge
PATCH/api/v1/boards/{id}/nodes/{nodeId}Update a node
DELETE/api/v1/boards/{id}/nodes/{nodeId}Delete a node

Subtasks

GET/api/v1/boards/{id}/nodes/{nodeId}/subtasksList a node’s subtasks
POST/api/v1/boards/{id}/nodes/{nodeId}/subtasksAdd a subtask

Edges

GET/api/v1/boards/{id}/edgesList a board’s edges
POST/api/v1/boards/{id}/edgesConnect two nodes
DELETE/api/v1/boards/{id}/edges/{edgeId}Remove an edge