API仕様書 | 使い方ガイド

共通の入口は https://pinateca.com/api。ワークスペース設定で発行したトークンを Authorization: Bearer に載せて呼びます。機械に読ませる定義は openapi.json にあります。

ボード

GET/boards

ボード一覧

ワークスペース内のボード一覧を取得

返り 200 ボード一覧

POST/boards

ボード作成

本体（JSON・必須）

名前	型	説明
`name`必須	文字列	ボード名
`boardType`	文字列	ボードタイプ

返り 201 作成されたボード

GET/boards/{boardId}/lists

ボード内のリスト一覧

ボードに属するリストを、名前と並び順だけの平らな配列で取得。カードは含まない

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 リストの配列

GET/boards/{boardId}

ボード詳細

リスト・カード・列・行ヘッダーを含むボード詳細を取得

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 ボード詳細

PATCH/boards/{boardId}

ボード更新

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON）

名前	型	説明
`name`	文字列
`description`	文字列
`settings`	オブジェクト	時間割設定等（visibleDays, startDay）

返り 200 更新されたボード

GET/boards/{boardId}/columns

列ヘッダー一覧（グリッド/時間割ボード）

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 列一覧

POST/boards/{boardId}/columns

列追加

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`name`必須	文字列

返り 201 作成された列

GET/boards/{boardId}/rows

行ヘッダー一覧（グリッド/時間割ボード）

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 行一覧

POST/boards/{boardId}/rows

行追加

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`name`必須	文字列

返り 201 作成された行

GET/boards/{boardId}/fields

カスタムフィールド一覧

カンバンボードに定義されたカスタムフィールド一覧を position 昇順で取得

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 フィールド一覧

POST/boards/{boardId}/fields

カスタムフィールド追加

カンバンボードに新しいフィールドを定義

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`name`必須	文字列	フィールド名
`fieldType`必須	文字列	フィールド型
`options`	オブジェクト
`showOnCard`	真偽	カンバンの一覧（カード）にも表示するか
`readOnly`	真偽	true なら UI 上で編集不可（API経由でのみ更新可能）

返り 201 作成されたフィールド

PATCH/boards/{boardId}/fields/{fieldId}

カスタムフィールド更新

フィールド定義を更新（fieldType は変更不可）

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値
`fieldId`必須	パス	数値

本体（JSON）

名前	型	説明
`name`	文字列
`options`	オブジェクト
`position`	数値	ボード内の表示順
`showOnCard`	真偽
`readOnly`	真偽	true なら UI 上で編集不可

返り 200 更新されたフィールド

DELETE/boards/{boardId}/fields/{fieldId}

カスタムフィールド削除

フィールド定義を削除。紐づく全カードの値もCASCADE削除される

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値
`fieldId`必須	パス	数値

返り 200 削除完了

GET/boards/{boardId}/field-values

ボード内全カードのフィールド値一括取得

カンバン一覧描画用。値が未設定の (cardId, fieldId) の組は含まれない

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 フィールド値一覧

カード

POST/cards

カード作成

リスト（セル）にカードを追加

本体（JSON・必須）

名前	型	説明
`listId`必須	数値	リスト（セル）ID
`title`必須	文字列	カードのタイトル
`description`	文字列	説明（任意）

返り 201 作成されたカード

GET/cards/{cardId}

カード詳細

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値

返り 200 カード詳細（サブタスク・ラベル・添付ファイル含む）

PATCH/cards/{cardId}

カード更新

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値

本体（JSON）

名前	型	説明
`title`	文字列
`description`	文字列
`listId`	数値	移動先リストID
`position`	数値
`startDate`	日時
`dueDate`	日時
`done`	真偽
`lastName`	文字列	標準フィールド: 姓
`firstName`	文字列	標準フィールド: 名
`email`	文字列	標準フィールド: メールアドレス
`phone`	文字列	標準フィールド: 電話番号

返り 200 更新されたカード

DELETE/cards/{cardId}

カード削除

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値

返り 200 削除完了

POST/cards/reorder

カード並べ替え・移動

カードの位置やリスト（セル）間の移動を一括更新

本体（JSON・必須）

名前	型	説明
`updates`必須	オブジェクトの配列

返り 200 更新完了

PUT/cards/{cardId}/fields/{fieldId}

カードのフィールド値を upsert

value:null を送ると既存値を削除する

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値
`fieldId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`value`		fieldType に応じた型（string / number / boolean / null）

返り 200 保存完了

リスト（セル）

PATCH/lists/{listId}

リスト（セル）更新

リストの名前やメタデータ（担当者、メモ等）を更新

渡すもの

名前	場所	型	説明
`listId`必須	パス	数値

本体（JSON）

名前	型	説明
`name`	文字列
`metadata`	オブジェクト	自由形式のメタデータ（例: {"teacher": "田中先生", "note": "3-A教室"}）

返り 200 更新されたリスト

ガントチャート

GET/gantt/boards/{boardId}

ガントボード概要

ガントボードのリスト一覧とフラットなタスク一覧をまとめて取得

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 ガントボード詳細

GET/gantt/boards/{boardId}/tasks

ガントタスク一覧（フラット）

ボード内の全タスクを position 順のフラット配列で取得。listName・開始日・終了日・完了フラグ含む

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

返り 200 タスク一覧

POST/gantt/boards/{boardId}/tasks

ガントタスク追加

タスクを追加。listId または listName を指定。どちらも省略すると先頭リストへ追加

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`title`必須	文字列	タスク名
`description`	文字列	説明（任意）
`startDate`	日時	開始日（ISO 8601）
`dueDate`	日時	終了日（ISO 8601）
`listId`	数値	配属リストID（指定時は同一ボード必須）
`listName`	文字列	配属リスト名。存在しなければ自動作成
`done`	真偽	完了フラグ

返り 201 作成されたタスク

PATCH/gantt/tasks/{cardId}

ガントタスク更新

タイトル・日付・完了状態・配属リストを更新

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値

本体（JSON）

名前	型	説明
`title`	文字列
`description`	文字列
`startDate`	日時
`dueDate`	日時
`done`	真偽
`position`	数値	リスト内の並び順
`listId`	数値	同一ボード内のリストへ移動
`listName`	文字列	リスト名で指定。存在しなければ作成

返り 200 更新されたタスク

DELETE/gantt/tasks/{cardId}

ガントタスク削除

渡すもの

名前	場所	型	説明
`cardId`必須	パス	数値

返り 200 削除完了

POST/gantt/boards/{boardId}/tasks/reorder

ガントタスク並び替え

タスクID配列を渡してフラット順を一括更新

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値

本体（JSON・必須）

名前	型	説明
`ids`必須	数値の配列	新しい並び順のタスクID配列

返り 200 更新完了

Webhook

GET/webhooks

Webhookの一覧

このワークスペースに登録されている送信先を返す

返り 200 送信先の一覧

POST/webhooks

Webhookの登録

出来事を知らせる送信先を作る。応答に含まれる secret は、このときだけ返る署名の鍵。

本体（JSON・必須）

名前	型	説明
`url`必須	文字列	送信先のURL
`name`	文字列	名前（任意）
`events`	文字列の配列	受け取る出来事。空なら全部（例: ["card.create","card.move"]）
`boardId`	数値	ボードを絞りたいとき（任意）

返り 201 作られた送信先（secret を含む）

GET/webhooks/events

送れる出来事の一覧

返り 200 出来事の名前と説明

PATCH/webhooks/{webhookId}

Webhookの更新

渡すもの

名前	場所	型	説明
`webhookId`必須	パス	数値

本体（JSON）

名前	型	説明
`url`	文字列
`name`	文字列
`events`	文字列の配列
`boardId`	数値
`status`	文字列	active か disabled

返り 200 更新された送信先

DELETE/webhooks/{webhookId}

Webhookの削除

渡すもの

名前	場所	型	説明
`webhookId`必須	パス	数値

返り 200 削除完了

GET/webhooks/{webhookId}/deliveries

送信の記録

直近50件。いつ・何を送って・どんな応答だったか

渡すもの

名前	場所	型	説明
`webhookId`必須	パス	数値

返り 200 送信の記録

POST/webhooks/{webhookId}/test

試し送り

ping という出来事をその場で1件送り、届いたかどうかを返す

渡すもの

名前	場所	型	説明
`webhookId`必須	パス	数値

返り 200 届いたかどうか

POST/webhooks/subscribe

購読の登録（自動化ツール用）

Zapier などが自分で呼ぶ口。1つの出来事につき1つの送信先を作り、その id を返す。

本体（JSON・必須）

名前	型	説明
`targetUrl`必須	文字列	知らせを受け取るURL
`event`必須	文字列	受け取る出来事（例: card.create）
`boardId`	数値

返り 201 作られた購読の id

DELETE/webhooks/subscribe/{webhookId}

購読の解除（自動化ツール用）

渡すもの

名前	場所	型	説明
`webhookId`必須	パス	数値

返り 200 解除完了

共通のきまり

応答は素の JSON。入れ物では包みません
うまくいかないときは {"error": "..."} が返ります
トークンはワークスペース単位。別のワークスペースのものは見えません
日時は ISO 8601（例 2026-09-30T09:00:00.000Z）