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 更新されたボード

DELETE/boards/{boardId}

ボードの削除

アーカイブ済みのボードだけ消せる。リストとカードも消える

渡すもの

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

返り 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 フィールド値一覧

GET/boards/{boardId}/labels

ボードのラベル一覧

渡すもの

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

返り 200 ラベルの配列

POST/boards/{boardId}/labels

ラベル作成

渡すもの

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

本体（JSON・必須）

名前	型	説明
`name`	文字列	ラベルの名前（色だけのラベルなら省略）
`color`必須	文字列	色（例: #3b82f6）

返り 201 作成されたラベル

GET/boards/{boardId}/assignables

ボードで担当者にできる人

そのボードのカードの担当者に選べる人の一覧

渡すもの

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

返り 200 人の配列

GET/boards/{boardId}/dependencies

ボードの依存関係の一覧

ボードのカードどうしの前後関係（先行の作業が終わったら後続の作業を始める）の一覧。ガントチャートの矢印と同じもの

渡すもの

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

返り 200 つながり（id・predecessorId・successorId）の配列

GET/boards/{boardId}/members

ボードのメンバー一覧

渡すもの

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

返り 200 メンバーの配列

POST/boards/{boardId}/members

ボードにメンバーを追加

渡すもの

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

本体（JSON・必須）

名前	型	説明
`userId`必須	数値	追加する人のメンバーID
`role`	文字列	ボードでの役割（admin・editor・commenter・viewer）

返り 201 追加したメンバー

PATCH/boards/{boardId}/members/{userId}

ボードでの役割を変える

渡すもの

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

本体（JSON・必須）

名前	型	説明
`role`必須	文字列	ボードでの役割（admin・editor・commenter・viewer）

返り 200 変えたあとの役割

DELETE/boards/{boardId}/members/{userId}

ボードからメンバーを外す

渡すもの

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

返り 200 外した

POST/boards/import/trello

Trello のボードを取り込む

Trello が書き出した JSON から、リスト・カード・ラベル・チェックリスト・コメント・期限を新しいカンバンに取り込む。本文の trelloJson に JSON の文字列を入れるか、file にファイルを付けて送る

本体（JSON・必須）

名前	型	説明
`trelloJson`必須	文字列	Trello の JSON の書き出し（文字列）

返り 200 成功

POST/boards/{boardId}/archive

ボードのアーカイブ

一覧から外す。中身は消さない

渡すもの

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

返り 200 成功

POST/boards/{boardId}/restore

アーカイブしたボードを戻す

渡すもの

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

返り 200 成功

POST/boards/reorder

ボードの並べ替え

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`orderedIds`必須	数値の配列	新しい並びのボードID

返り 200 成功

GET/boards/favorites

お気に入りのボード

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

PUT/boards/favorites

お気に入りのボードを設定

渡したボードIDの並びで置き換える。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`boardIds`必須	数値の配列	ボードID（並び順）

返り 200 成功

GET/boards/{boardId}/trash

ゴミ箱（ボード）

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

PATCH/boards/{boardId}/columns/{columnId}

列の名前を変える

渡すもの

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

本体（JSON・必須）

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

返り 200 成功

DELETE/boards/{boardId}/columns/{columnId}

列を消す

渡すもの

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

返り 200 成功

PATCH/boards/{boardId}/rows/{rowId}

行の名前を変える

渡すもの

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

本体（JSON・必須）

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

返り 200 成功

DELETE/boards/{boardId}/rows/{rowId}

行を消す

渡すもの

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

返り 200 成功

GET/boards/{boardId}/cards

ボードの全カード

リストをまたいで、ボードのカードを1回で返す

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID

返り 200 成功

GET/boards/{boardId}/mention-candidates

メンションできる人

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID

返り 200 成功

POST/boards/{boardId}/columns/reorder

グリッドの列の並べ替え

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID

本体（JSON・必須）

名前	型	説明
`updates`必須	オブジェクトの配列	列の ID と並び順

返り 200 成功

PATCH/boards/{boardId}/columns/{columnId}/resize

グリッドの列の幅

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID
`columnId`必須	パス	数値	列の ID

本体（JSON・必須）

名前	型	説明
`width`必須	数値	幅（80〜800。null で既定）

返り 200 成功

POST/boards/{boardId}/rows/reorder

グリッドの行の並べ替え

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID

本体（JSON・必須）

名前	型	説明
`updates`必須	オブジェクトの配列	行の ID と並び順

返り 200 成功

PATCH/boards/{boardId}/rows/{rowId}/resize

グリッドの行の高さ

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID
`rowId`必須	パス	数値	行の ID

本体（JSON・必須）

名前	型	説明
`height`必須	数値	高さ（48〜800。null で既定）

返り 200 成功

GET/boards/{boardId}/available-roles

項目の権限に使えるロール

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID

返り 200 成功

GET/boards/{boardId}/fields/{fieldId}/permissions

カスタム項目の権限

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID
`fieldId`必須	パス	数値	項目の ID

返り 200 成功

PUT/boards/{boardId}/fields/{fieldId}/permissions

カスタム項目の権限を設定

ロールごとに、見られるか・変えられるかを許可・拒否・引き継ぎで決める

渡すもの

名前	場所	型	説明
`boardId`必須	パス	数値	ボードの ID
`fieldId`必須	パス	数値	項目の ID

本体（JSON・必須）

名前	型	説明
`entries`必須	オブジェクトの配列	ロールごとの設定

返り 200 成功

カード

POST/cards

カード作成

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

本体（JSON・必須）

名前	型	説明
`listId`必須	数値	リスト（セル）ID
`title`必須	文字列	カードのタイトル
`position`	数値	並び順（省略するとリストの末尾。リソースのボードでは入れる行の番号）
`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 保存完了

GET/cards/{cardId}/comments

コメント一覧

カードに付いたコメントを古い順に取得。返信とリアクションを含む

渡すもの

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

返り 200 コメントの配列

POST/cards/{cardId}/comments

コメント投稿

カードにコメントを書く。@ユーザー名でメンションすると、その人に通知が届く

渡すもの

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

本体（JSON・必須）

名前	型	説明
`body`	文字列	コメントの本文（5000文字まで）
`parentId`	数値	返信先のコメントID（省略するとトップレベル）
`closeCard`	真偽	true なら書くと同時にカードを完了にする
`attachmentIds`	数値の配列	先にカードへ添付したファイルのうち、このコメントに付けるもの（10件まで。付けたときは本文を空にできる）

返り 201 作成されたコメント

GET/cards/{cardId}/labels

カードのラベル一覧

渡すもの

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

返り 200 ラベルの配列

POST/cards/{cardId}/labels/{labelId}

カードにラベルを付ける

渡すもの

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

返り 201 付けた

DELETE/cards/{cardId}/labels/{labelId}

カードからラベルを外す

渡すもの

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

返り 200 外した

GET/cards/{cardId}/subtasks

チェックリスト一覧

カードのチェックリストの項目を並び順で取得

渡すもの

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

返り 200 チェックリストの項目の配列

POST/cards/{cardId}/subtasks

チェックリストの項目を追加

渡すもの

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

本体（JSON・必須）

名前	型	説明
`title`必須	文字列	項目の文言（500文字まで）

返り 201 作成された項目

GET/cards/{cardId}/members

カードの担当者一覧

渡すもの

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

返り 200 担当者の配列

POST/cards/{cardId}/members

カードに担当者を付ける

担当者の候補は「ボードで担当者にできる人」で取得する

渡すもの

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

本体（JSON・必須）

名前	型	説明
`userId`必須	数値	担当者にする人のメンバーID

返り 201 付けた担当者

DELETE/cards/{cardId}/members/{memberId}

カードから担当者を外す

渡すもの

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

返り 200 外した

GET/cards/{cardId}/links

カードのリンク一覧

渡すもの

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

返り 200 リンクの配列

POST/cards/{cardId}/links

カードにリンクを追加

Google ドライブなど外に置いた資料の URL をカードに付ける

渡すもの

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

本体（JSON・必須）

名前	型	説明
`url`必須	文字列	リンク先の URL
`name`	文字列	表示名（省略すると URL をそのまま出す）

返り 201 作成されたリンク

GET/cards/{cardId}/dependencies

カードの先行する作業と後続の作業

渡すもの

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

返り 200 predecessors（先行する作業）と successors（後続の作業）

POST/cards/{cardId}/dependencies

カードに先行する作業をつなぐ

predecessorId のカードが終わったら、このカードを始める、というつながりを作る。同じボードのカードどうしだけ。輪になるつなぎ方は断る

渡すもの

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

本体（JSON・必須）

名前	型	説明
`predecessorId`必須	数値	先行する作業のカードの番号

返り 200 すでにつながっていた / 201 作成したつながり

DELETE/cards/{cardId}/dependencies/{predecessorId}

カードの先行する作業とのつながりを外す

渡すもの

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

返り 200 外した

GET/cards/{cardId}/attachments

添付ファイル一覧

渡すもの

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

返り 200 添付ファイルの配列

POST/cards/{cardId}/attachments

ファイルを添付

multipart/form-data の file 欄でファイルを送る

渡すもの

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

返り 201 作成された添付

POST/cards/{cardId}/attachments/external

外部のファイルをリンクで添付

ファイルを送らずに、外に置いたファイルの URL を添付として付ける。容量には数えない

渡すもの

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

本体（JSON・必須）

名前	型	説明
`url`必須	文字列	ファイルの URL
`filename`	文字列	表示するファイル名
`mimeType`	文字列	ファイルの種類（例: application/pdf）

返り 201 作成された添付

POST/cards/{cardId}/move

カードを別のボードへ移す

移動先のリストを指定して、カードを別のボードへ移す。同じボードの中で動かすときはカード更新の listId を使う

渡すもの

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

本体（JSON・必須）

名前	型	説明
`targetListId`必須	数値	移動先のリストID

返り 200 移したカード

PATCH/cards/{cardId}/cover

カードのカバー

色（#RRGGBB）か画像のURL。どちらも無しで外す

渡すもの

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

本体（JSON・必須）

名前	型	説明
`color`	文字列	色
`url`	文字列	画像のURL

返り 200 成功

POST/cards/{cardId}/restore

削除したカードを戻す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

DELETE/cards/{cardId}/purge

ゴミ箱のカードを完全に削除

元に戻せない。削除した本人・ボードの管理者・ワークスペースの管理者だけ

渡すもの

名前	場所	型	説明
`cardId`必須	パス	文字列	カードの ID

返り 200 成功

リスト（セル）

POST/lists

リスト作成

ボードにリスト（カンバンの列）を足す

本体（JSON・必須）

名前	型	説明
`boardId`必須	数値	ボードID
`name`必須	文字列	リストの名前

返り 201 作成されたリスト

POST/lists/reorder

リストの並べ替え

本体（JSON・必須）

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

返り 200 並べ替えた

GET/lists/{listId}/cards

リストのカード一覧

渡すもの

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

返り 200 カードの配列

DELETE/lists/{listId}

リスト削除

リストを消す。中のカードも一緒に消える

渡すもの

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

返り 200 削除した

PATCH/lists/{listId}

リスト（セル）更新

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

渡すもの

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

本体（JSON）

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

返り 200 更新されたリスト

POST/lists/resize

カンバンの列の幅

本体（JSON・必須）

名前	型	説明
`listIds`必須	数値の配列	リストの ID
`width`必須	数値	幅（180〜900。null で既定）

返り 200 成功

GET/lists/{listId}/attachments

リスト（グリッドのセル）の添付

渡すもの

名前	場所	型	説明
`listId`必須	パス	数値	リストの ID

返り 200 成功

POST/lists/{listId}/attachments

リスト（グリッドのセル）にファイルを添付

渡すもの

名前	場所	型	説明
`listId`必須	パス	数値	リストの ID

返り 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 解除完了

comments

PATCH/comments/{commentId}

コメント編集

渡すもの

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

本体（JSON・必須）

名前	型	説明
`body`必須	文字列	コメントの本文（5000文字まで）

返り 200 更新されたコメント

DELETE/comments/{commentId}

コメント削除

渡すもの

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

返り 200 削除した

POST/comments/{commentId}/reactions

コメントにリアクション

同じ絵文字でもう一度送ると外れる

渡すもの

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

本体（JSON・必須）

名前	型	説明
`emoji`必須	文字列	絵文字1つ

返り 200 成功

labels

PATCH/labels/{labelId}

ラベル更新

渡すもの

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

本体（JSON・必須）

名前	型	説明
`name`	文字列	ラベルの名前（色だけのラベルなら省略）
`color`	文字列	色（例: #3b82f6）

返り 200 更新されたラベル

DELETE/labels/{labelId}

ラベル削除

ボードからラベルを消す。付いていたカードからも外れる

渡すもの

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

返り 200 削除した

subtasks

PATCH/subtasks/{subtaskId}

チェックリストの項目を更新

文言の変更、完了・未完了の切り替え、並び順の変更

渡すもの

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

本体（JSON・必須）

名前	型	説明
`title`	文字列	項目の文言（500文字まで）
`done`	真偽	完了なら true
`position`	数値	並び順

返り 200 更新された項目

DELETE/subtasks/{subtaskId}

チェックリストの項目を削除

渡すもの

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

返り 200 削除した

card-links

PATCH/card-links/{linkId}

カードのリンクを更新

渡すもの

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

本体（JSON・必須）

名前	型	説明
`url`	文字列	リンク先の URL
`name`	文字列	表示名（省略すると URL をそのまま出す）
`position`	数値	並び順

返り 200 更新されたリンク

DELETE/card-links/{linkId}

カードのリンクを削除

渡すもの

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

返り 200 削除した

files

GET/files

ファイルの一覧

カードの添付とチャットで送ったファイルを新しい順に返す。カードは見られるボードのもの、チャットは参加している会話のものだけ。ワークスペースの API トークンではカードの添付だけを返す

渡すもの

名前	場所	型	説明
`source`	クエリ	文字列	置き場所で絞る
`kind`	クエリ	文字列	ファイルの種類で絞る
`q`	クエリ	文字列	ファイル名の検索
`before`	クエリ	日時	これより前に置いたものだけ（続きを読むとき）
`limit`	クエリ	数値	件数（既定50）

返り 200 ファイルの配列

attachments

DELETE/attachments/{attachmentId}

添付ファイルを削除

渡すもの

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

返り 200 削除した

GET/attachments/{attachmentId}/text

添付の本文を読む

PDF・Word・Excel・テキストの中身の文字

渡すもの

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

返り 200 成功

GET/attachments/{attachmentId}/raw

添付ファイルを取り出す

渡すもの

名前	場所	型	説明
`attachmentId`必須	パス	数値	添付の ID

返り 200 成功

members

GET/members

ワークスペースのメンバー一覧

ワークスペースに参加している人の一覧。メンバーIDは担当者やボードのメンバーの指定に使う

返り 200 メンバーの配列

GET/members/me

自分の情報

この鍵で動いている本人のメンバー情報（ID・名前・ユーザー名・役割）。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

GET/members/online

オンラインのメンバー

いま Pinateca を開いている人

返り 200 成功

DELETE/members/{userId}

ワークスペースからメンバーを外す

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

返り 200 成功

PATCH/members/{userId}/role

メンバーの立場を変える

オーナー・管理者・メンバー・閲覧だけのゲスト。管理者だけが使える

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

本体（JSON・必須）

名前	型	説明
`role`必須	文字列	立場

返り 200 成功

PUT/members/{userId}/roles

メンバーのカスタムロールを設定

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

本体（JSON・必須）

名前	型	説明
`roleIds`必須	数値の配列	ロールの ID（これで置き換える）

返り 200 成功

GET/members/{userId}/boards

メンバーが入っているボードと役割

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

返り 200 成功

PUT/members/{userId}/boards

メンバーのボードと役割をまとめて設定

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

本体（JSON・必須）

名前	型	説明
`assignments`必須	オブジェクトの配列	ボードと役割（これで置き換える）

返り 200 成功

POST/members/{userId}/link

名前だけのメンバーを実在の人に結びつける

移行で名前だけ作った人を、そのアドレスで参加している人に結びつける。過去の稼働や契約はそのまま残る。管理者だけが使える

渡すもの

名前	場所	型	説明
`userId`必須	パス	数値	メンバーの ID

本体（JSON・必須）

名前	型	説明
`email`必須	文字列	参加している人のメールアドレス

返り 200 成功

search

GET/search

カード検索

カードのタイトル・説明・コメント・添付の本文から探す

渡すもの

名前	場所	型	説明
`q`必須	クエリ	文字列	探す言葉
`scope`	クエリ	文字列	all ならワークスペース全体、board なら boardId のボードだけ
`boardId`	クエリ	文字列	scope が board のときのボードID
`limit`	クエリ	数値	返す件数（既定30）

返り 200 見つかったカード

activity-logs

GET/activity-logs

操作ログ

誰がいつ何をしたか（カードの作成・移動・更新・完了・削除、コメントなど）。新しい順

渡すもの

名前	場所	型	説明
`boardId`	クエリ	数値	このボードだけ
`actorMemberId`	クエリ	数値	この人の操作だけ
`action`	クエリ	文字列	この種類の操作だけ（例 card.created）
`limit`	クエリ	数値	件数（既定50）
`beforeId`	クエリ	数値	このIDより古いもの（ページ送り）

返り 200 成功

inbox

GET/inbox

インボックス

自分のカードを全ボードから集める（担当・作成・すべて）。期限切れと期限の近いものが先。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`filter`	クエリ	文字列	assigned・created・all（既定 assigned）
`includeDone`	クエリ	文字列	true なら完了したカードも

返り 200 成功

GET/inbox/count

インボックスの件数

期限切れと合計の件数。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

notifications

GET/notifications

お知らせ一覧

メンション・担当になった・コメント・招待など。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

GET/notifications/unread-count

未読のお知らせの数

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

POST/notifications/{notificationId}/read

お知らせを既読にする

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

POST/notifications/read-all

お知らせをすべて既読にする

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

DELETE/notifications/{notificationId}

お知らせを削除

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`notificationId`必須	パス	数値	お知らせの ID

返り 200 成功

GET/notifications/settings

お知らせの受け取り方

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

PATCH/notifications/settings

お知らせの受け取り方を変える

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON）

名前	型	説明
`notifyEmailMention`	真偽	メンションをメールで受け取る
`notifyEmailAssigned`	真偽	担当になったらメールで受け取る
`notifyEmailChat`	真偽	未読のチャットをメールで受け取る
`notifyBrowserMention`	真偽	メンションをブラウザで受け取る
`notifyBrowserAssigned`	真偽	担当になったらブラウザで受け取る
`notifyBrowserChat`	真偽	チャットをブラウザで受け取る

返り 200 成功

chat

GET/chat/conversations

チャットの会話一覧

1対1とグループ。最後の発言と未読の数つき。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

POST/chat/conversations

1対1のチャットを始める

既にあればその会話を返す。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`withUserId`必須	数値	相手のメンバーID

返り 200 成功

POST/chat/conversations/group

グループチャットを作る

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`name`	文字列	グループの名前
`userIds`	数値の配列	入れるメンバーID
`roleIds`	数値の配列	このロールの人を全員入れる

返り 200 成功

PATCH/chat/conversations/{conversationId}

グループチャットの名前を変える

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

本体（JSON・必須）

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

返り 200 成功

POST/chat/conversations/{conversationId}/participants

グループチャットに人を足す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

本体（JSON・必須）

名前	型	説明
`userIds`	数値の配列	メンバーID
`roleIds`	数値の配列	ロールID

返り 200 成功

GET/chat/conversations/{conversationId}/messages

チャットの発言一覧

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

POST/chat/conversations/{conversationId}/messages

チャットに発言する

@ユーザー名でメンションできる。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

本体（JSON・必須）

名前	型	説明
`body`必須	文字列	本文（5000文字まで）

返り 200 成功

POST/chat/conversations/{conversationId}/read

会話を既読にする

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

PATCH/chat/messages/{messageId}

チャットの発言を直す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

本体（JSON・必須）

名前	型	説明
`body`必須	文字列	本文

返り 200 成功

DELETE/chat/messages/{messageId}

チャットの発言を消す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

POST/chat/messages/{messageId}/reactions

チャットの発言にリアクション

同じ絵文字でもう一度送ると外れる。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

本体（JSON・必須）

名前	型	説明
`emoji`必須	文字列	絵文字1つ

返り 200 成功

GET/chat/unread-count

チャットの未読の数

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

PATCH/chat/conversations/{conversationId}/pin

会話を上に固定

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

本体（JSON・必須）

名前	型	説明
`pinned`必須	真偽	固定する（false で外す）

返り 200 成功

GET/chat/conversations/{conversationId}/read-receipts

会話をどこまで読んだか

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

返り 200 成功

POST/chat/conversations/reorder

会話の並び順

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`orderedIds`必須	数値の配列	会話の ID（上から順に）

返り 200 成功

POST/chat/conversations/{conversationId}/leave

グループチャットから抜ける

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

返り 200 成功

DELETE/chat/conversations/{conversationId}/participants/{userId}

グループチャットから人を外す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID
`userId`必須	パス	数値	メンバーの ID

返り 200 成功

POST/chat/conversations/{conversationId}/attachments

チャットにファイルを送る

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

返り 200 成功

POST/chat/conversations/{conversationId}/icon

グループチャットのアイコンを設定

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

返り 200 成功

DELETE/chat/conversations/{conversationId}/icon

グループチャットのアイコンを外す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`conversationId`必須	パス	数値	会話の ID

返り 200 成功

videos

GET/videos/{videoId}/transcript

会議の録画の文字起こし

整えた本文・要約・話者と時刻つきの発言

渡すもの

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

返り 200 成功

GET/videos/{videoId}/playback

会議の録画を再生する住所

期限付きの再生用の住所と、変換の状態を返す

渡すもの

名前	場所	型	説明
`videoId`必須	パス	数値	動画の添付の ID

返り 200 成功

trash

GET/trash

ゴミ箱（全ボード）

30日以内に削除したカード。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

time-entries

GET/time-entries

稼働の記録の一覧

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`from`必須	クエリ	文字列	開始日（YYYY-MM-DD）
`to`必須	クエリ	文字列	終了日（YYYY-MM-DD）
`memberId`	クエリ	数値	この人の分（管理する人だけ）

返り 200 成功

PUT/time-entries

稼働を記録する

同じ日・案件・作業区分は置き換える（週の表の1マス）。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`workDate`必須	文字列	日付（YYYY-MM-DD）
`minutes`必須	数値	分
`projectId`	数値	案件ID
`categoryId`	数値	作業区分ID
`cardId`	数値	カードID
`note`	文字列	メモ
`billable`	真偽	請求の対象か
`memberId`	数値	この人の分として記録（管理する人だけ）

返り 200 成功

DELETE/time-entries/{entryId}

稼働の記録を消す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

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

返り 200 成功

projects

GET/projects

稼働の案件一覧

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`includeArchived`	クエリ	文字列	true ならアーカイブした案件も

返り 200 成功

POST/projects

稼働の案件を作る

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`name`必須	文字列	案件名
`clientName`	文字列	取引先
`boardId`	数値	結び付けるボード
`color`	文字列	色

返り 200 成功

PATCH/projects/{projectId}

稼働の案件を更新

名前・色・取引先・結び付けるボード・アーカイブを変える

渡すもの

名前	場所	型	説明
`projectId`必須	パス	数値	案件の ID

本体（JSON）

名前	型	説明
`name`	文字列	案件名
`color`	文字列	色
`clientName`	文字列	取引先
`boardId`	数値	結び付けるボード
`archived`	真偽	アーカイブする

返り 200 成功

DELETE/projects/{projectId}

稼働の案件を削除

稼働が1件も無い案件だけ削除できる

渡すもの

名前	場所	型	説明
`projectId`必須	パス	数値	案件の ID

返り 200 成功

PUT/projects/{projectId}/members

案件の担当者を設定

渡すもの

名前	場所	型	説明
`projectId`必須	パス	数値	案件の ID

本体（JSON・必須）

名前	型	説明
`memberIds`必須	数値の配列	担当者のメンバー ID（これで置き換える）

返り 200 成功

PATCH/projects/archive

案件をまとめてアーカイブ

本体（JSON・必須）

名前	型	説明
`projectIds`必須	数値の配列	案件の ID
`archived`必須	真偽	アーカイブする（false で戻す）

返り 200 成功

work-categories

GET/work-categories

作業区分の一覧

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

POST/work-categories

作業区分を作る

本体（JSON・必須）

名前	型	説明
`name`必須	文字列	作業区分の名前

返り 200 成功

PATCH/work-categories/{categoryId}

作業区分を更新

渡すもの

名前	場所	型	説明
`categoryId`必須	パス	数値	作業区分の ID

本体（JSON）

名前	型	説明
`name`	文字列	作業区分の名前
`position`	数値	並び順
`archived`	真偽	アーカイブする

返り 200 成功

DELETE/work-categories/{categoryId}

作業区分を削除

稼働が1件も無い作業区分だけ削除できる

渡すもの

名前	場所	型	説明
`categoryId`必須	パス	数値	作業区分の ID

返り 200 成功

reports

GET/reports/time

稼働の集計

人・案件・作業区分ごとの合計。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`from`必須	クエリ	文字列	開始日
`to`必須	クエリ	文字列	終了日
`memberId`	クエリ	数値	この人だけ
`projectId`	クエリ	数値	この案件だけ

返り 200 成功

GET/reports/statement

稼働の明細

案件ごとの時間と金額（請求のもと）。人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`from`必須	クエリ	文字列	開始日
`to`必須	クエリ	文字列	終了日
`memberId`	クエリ	数値	この人の分（既定は自分）

返り 200 成功

GET/reports/time.csv

稼働の集計を CSV で書き出す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`from`必須	クエリ	文字列	開始日（YYYY-MM-DD）
`to`必須	クエリ	文字列	終了日（YYYY-MM-DD）
`memberId`	クエリ	数値	この人だけ
`projectId`	クエリ	数値	この案件だけ

返り 200 成功

contracts

GET/contracts

契約の一覧

時間単価・固定額・月額の契約。契約を管理する人は全員分、それ以外は自分の分

渡すもの

名前	場所	型	説明
`activeOnly`	クエリ	真偽	有効な契約だけ（true）

返り 200 成功

POST/contracts

契約を作る

本体（JSON・必須）

名前	型	説明
`memberId`必須	数値	契約する人
`projectId`	数値	案件
`contractType`必須	文字列	契約の種類
`hourlyRate`	数値	時間単価
`totalAmount`	数値	固定額
`monthlyAmount`	数値	月額
`deliverable`	文字列	納品物
`dueDate`	文字列	納期（YYYY-MM-DD）
`validFrom`必須	文字列	開始日（YYYY-MM-DD）
`validTo`	文字列	終了日（YYYY-MM-DD）

返り 200 成功

assignments

PATCH/assignments/{assignmentId}/status

固定額の仕事の進み具合を変える

受け入れ（accepted）と差し戻し（returned）は承認できる人だけ

渡すもの

名前	場所	型	説明
`assignmentId`必須	パス	数値	仕事の ID

本体（JSON・必須）

名前	型	説明
`status`必須	文字列	進み具合

返り 200 成功

project-tasks

GET/project-tasks

案件の作業の一覧

渡すもの

名前	場所	型	説明
`projectId`	クエリ	数値	この案件だけ

返り 200 成功

POST/project-tasks

案件の作業を作る

本体（JSON・必須）

名前	型	説明
`projectId`必須	数値	案件
`name`必須	文字列	作業の名前

返り 200 成功

PATCH/project-tasks/{taskId}

案件の作業を更新

渡すもの

名前	場所	型	説明
`taskId`必須	パス	数値	作業の ID

本体（JSON）

名前	型	説明
`name`	文字列	作業の名前
`archived`	真偽	アーカイブする

返り 200 成功

timesheet-favorites

GET/timesheet-favorites

タイムシートのよく使う行

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

返り 200 成功

POST/timesheet-favorites

よく使う行を登録

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON）

名前	型	説明
`projectId`	数値	案件
`taskId`	数値	作業
`categoryId`	数値	作業区分

返り 200 成功

DELETE/timesheet-favorites/{favoriteId}

よく使う行を外す

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`favoriteId`必須	パス	数値	よく使う行の ID

返り 200 成功

time-permissions

GET/time-permissions

タイムシートで自分ができること

記録・全員の閲覧・代理入力・承認・契約・設定のそれぞれを、できるかどうかで返す

返り 200 成功

timesheet-submissions

GET/timesheet-submissions

期間の提出の状態

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

渡すもの

名前	場所	型	説明
`periodStart`必須	クエリ	文字列	期間の開始日（YYYY-MM-DD）
`periodEnd`必須	クエリ	文字列	期間の終了日（YYYY-MM-DD）
`memberId`	クエリ	数値	この人の分（既定は自分）

返り 200 成功

POST/timesheet-submissions

タイムシートを提出

人として動く鍵（AI の画面からログインしてつなぐ鍵、またはログインした画面）が必要。ワークスペースの API トークンでは使えない

本体（JSON・必須）

名前	型	説明
`periodStart`必須	文字列	期間の開始日（YYYY-MM-DD）
`periodEnd`必須	文字列	期間の終了日（YYYY-MM-DD）
`memberId`	数値	この人の分（既定は自分）
`note`	文字列	ひとこと

返り 200 成功

GET/timesheet-submissions/list

提出の一覧

承認を待っているものを含む。全員分を見られるのは閲覧の権限がある人だけ

渡すもの

名前	場所	型	説明
`from`必須	クエリ	文字列	開始日（YYYY-MM-DD）
`to`必須	クエリ	文字列	終了日（YYYY-MM-DD）
`memberId`	クエリ	数値	この人だけ

返り 200 成功

POST/timesheet-submissions/{submissionId}/review

タイムシートを承認・差し戻し

承認できる人だけ

渡すもの

名前	場所	型	説明
`submissionId`必須	パス	数値	提出の ID

本体（JSON・必須）

名前	型	説明
`action`必須	文字列	承認（approve）か差し戻し（return）
`note`	文字列	ひとこと

返り 200 成功

roles

GET/roles

カスタムロールの一覧

返り 200 成功

POST/roles

カスタムロールを作る

ワークスペースの管理者だけが使える

本体（JSON・必須）

名前	型	説明
`name`必須	文字列	ロールの名前
`color`	文字列	色（#RRGGBB）

返り 200 成功

PATCH/roles/{roleId}

カスタムロールを更新

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`roleId`必須	パス	数値	ロールの ID

本体（JSON）

名前	型	説明
`name`	文字列	ロールの名前
`color`	文字列	色（#RRGGBB）

返り 200 成功

DELETE/roles/{roleId}

カスタムロールを削除

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`roleId`必須	パス	数値	ロールの ID

返り 200 成功

GET/roles/{roleId}/members

ロールの人の一覧

渡すもの

名前	場所	型	説明
`roleId`必須	パス	数値	ロールの ID

返り 200 成功

PUT/roles/{roleId}/members

ロールの人を設定

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`roleId`必須	パス	数値	ロールの ID

本体（JSON・必須）

名前	型	説明
`memberIds`必須	数値の配列	メンバーの ID（これで置き換える）

返り 200 成功

PUT/roles/positions

カスタムロールの並び順

ワークスペースの管理者だけが使える

本体（JSON・必須）

名前	型	説明
`orders`必須	オブジェクトの配列	ロールの ID と並び順

返り 200 成功

invitations

GET/invitations

招待の一覧

まだ受けていない招待。管理者だけが使える

返り 200 成功

POST/invitations

ワークスペースに招待する

招待のメールを送る。閲覧だけのゲストは人数に数えない。管理者だけが使える

本体（JSON・必須）

名前	型	説明
`email`必須	文字列	招待する人のメールアドレス
`role`	文字列	立場
`boardAssignments`	オブジェクトの配列	最初から入れるボードと役割

返り 200 成功

DELETE/invitations/{invitationId}

招待を取り消す

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`invitationId`必須	パス	数値	招待の ID

返り 200 成功

POST/invitations/{invitationId}/resend

招待のメールを送り直す

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`invitationId`必須	パス	数値	招待の ID

返り 200 成功

imported-members

GET/imported-members

取り込みで作った名前だけのメンバー

Trello などから取り込んだときに、まだ参加していない人の代わりに作った名前。管理者だけが使える

返り 200 成功

PATCH/imported-members/{importedMemberId}

名前だけのメンバーのメールアドレスを設定

この人が同じアドレスで参加すると、自動で結びつく。管理者だけが使える

渡すもの

名前	場所	型	説明
`importedMemberId`必須	パス	数値	名前だけのメンバーの ID

本体（JSON・必須）

名前	型	説明
`email`必須	文字列	メールアドレス

返り 200 成功

DELETE/imported-members/{importedMemberId}

名前だけのメンバーを削除

ワークスペースの管理者だけが使える

渡すもの

名前	場所	型	説明
`importedMemberId`必須	パス	数値	名前だけのメンバーの ID

返り 200 成功

POST/imported-members/{importedMemberId}/link

名前だけのメンバーを、参加している人に結びつける

担当やコメントの書き手が、その人に付け替わる。管理者だけが使える

渡すもの

名前	場所	型	説明
`importedMemberId`必須	パス	数値	名前だけのメンバーの ID

本体（JSON・必須）

名前	型	説明
`userId`必須	数値	結びつける先のメンバーの ID

返り 200 成功

workspace

GET/workspace/settings

ワークスペースの設定

返り 200 成功

PATCH/workspace/settings

ワークスペースの設定を変える

ワークスペースの管理者だけが使える

本体（JSON）

名前	型	説明
`boardCreationRole`	文字列	ボードを作れる人
`currency`	文字列	金額の通貨（ISO 4217）
`timeStepMinutes`	数値	タイムシートの刻み（分）

返り 200 成功

共通のきまり

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