開発者

Planitude で構築する

REST API、署名付き Webhook、MCP サーバー。システムを計画と同期させ、あらゆる変更に反応し、AI アシスタントにプロジェクトを任せられます。

コード、フィールド名、技術リファレンスは多くの API ドキュメントと同じく英語です。

ベース URL: https://planitude.app

リクエストとレスポンスは HTTPS 上の JSON です。期間とラグは稼働分(8 時間の 1 日は 480)、日時は UTC の ISO 8601、時刻なしの日付は YYYY-MM-DD です。

リクエスト
curl https://planitude.app/api/auth/me \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "user": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "email": "anna@example.com",
    "name": "Anna Rossi",
    "avatarUrl": null,
    "locale": "en",
    "emailVerified": true
  }
}

クイックスタート

3 ステップで最初の Webhook まで。必要なのはターミナルだけです。

  1. API キーを作成

    プロフィール → API キーを開き、読み取りと書き込みを選んでキーをコピーします。キーは pln_ で始まり、一度だけ表示されます。環境変数に保存してください。

  2. 最初の呼び出し

    表示できるプロジェクトを一覧します。キーはあなたとして動作します。プロジェクトも役割も同じです。

  3. Webhook を受け取る

    公開 HTTPS エンドポイントを必要なイベントに登録し、すぐにテストイベントを送って署名を検証します。

1Terminal
export PLANITUDE_API_KEY="pln_…"
2
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
期待される結果200 OK
{
  "projects": [
    {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "keyLocked": false,
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "calendarId": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "deadline": null,
      "color": null,
      "settings": {},
      "archivedAt": null,
      "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "workspaceName": "Acme Construction",
      "role": "owner",
      "taskCount": 12,
      "finishAt": "2026-10-07T15:00:00.000Z"
    }
  ]
}
3
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
ペイロードの例webhook.ping
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "webhook.ping",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {
    "message": "Planitude webhook test",
    "webhook": {
      "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
      "name": "Warehouse sync",
      "events": [
        "task.created",
        "task.completed"
      ]
    }
  }
}

認証

すべてのリクエストを、Authorization ヘッダーの個人用 API キー(ベアラートークン)で認証します。キーは個人用で、各プロジェクトでのあなたの役割で動作し、それ以上の権限はありません。キーは 1 つのワークスペースに限定したり、有効期限を付けたり、いつでも取り消したりでき、すべての呼び出しがキーごとに記録されます。

スコープ

スコープできること
readplanitude:readプロジェクト、タスク、依存関係、メンバー、コメント、ベースライン、Webhook の読み取り。
writeplanitude:write読み取りのすべてに加え、プロジェクト、タスク、依存関係、コメント、ベースライン、Webhook の作成と変更。

キーと OAuth アプリはプロジェクトやタスクを削除できません。削除は人が確認する Web アプリでのみ行えます。誤った ID を指定したスクリプトが計画を消すことはありません。

サードパーティアプリ向け OAuth 2.1

他の人の代わりに動作するアプリは OAuth 2.1 を使います。PKCE(S256)付きの認可コード、使用のたびにローテーションされるリフレッシュトークン、動的クライアント登録(RFC 7591)に対応します。リソース https://planitude.app/api とスコープ planitude:read または planitude:write を要求してください。

エンドポイントは標準のディスカバリードキュメントで公開されているため、OAuth ライブラリは自動で設定されます。

  • https://planitude.app/.well-known/oauth-authorization-server
  • https://planitude.app/.well-known/oauth-protected-resource

推奨事項

  • キーは環境変数やシークレットマネージャーに保管し、コードやリポジトリには置かないでください。キーは pln_ で始まるため、シークレットスキャナーが検出できます。
  • 読むだけなら読み取り専用キーを使い、連携ごとに別のキーを使います。1 つを取り消しても他は止まりません。
  • スクリプト用のキーには有効期限を付け、定期的に入れ替えます。
  • API はブラウザではなくサーバーから呼び出します。フロントエンドのコードにあるキーは公開キーと同じです。
Bearercurl
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
OAuth 2.1/.well-known/oauth-authorization-server
{
  "issuer": "https://planitude.app",
  "authorization_endpoint": "https://planitude.app/oauth/authorize",
  "token_endpoint": "https://planitude.app/api/oauth/token",
  "registration_endpoint": "https://planitude.app/api/oauth/register",
  "revocation_endpoint": "https://planitude.app/api/oauth/revoke",
  "scopes_supported": [
    "planitude:read",
    "planitude:write"
  ],
  "grant_types_supported": [
    "authorization_code",
    "refresh_token"
  ],
  "code_challenge_methods_supported": [
    "S256"
  ]
}

エラー

Planitude は標準の HTTP ステータスコードを使います。エラーは常に同じ JSON 形式で、分岐に使える安定した error コードと、必要に応じて理由や修正すべきフィールドを示す details を含みます。

ステータス意味
400invalid_requestリクエストが無効です。details.fields に各フィールドと問題が並びます。
401unauthorizedキーがない、無効、取り消し済み、または期限切れです。
403forbiddenキーまたは役割で許可されていません(details.reason)。読み取り専用キーでの書き込みや削除などです。
404not_found見つからないか、あなたには表示されません。
409dependency_cycle計画と矛盾します。循環を作る依存関係(dependency_cycle)などです。
429rate_limitedリクエストが多すぎます。Retry-After の秒数だけ待ってください。
500server_errorこちら側のエラーです。指数バックオフで再試行してください。

Error

フィールド型説明
error
必須
stringStable error code: invalid_request, unauthorized, forbidden, not_found, conflict, dependency_cycle, limit_exceeded, rate_limited, server_error, ...
detailsobject
レスポンス
{
  "error": "invalid_request",
  "details": {
    "fields": [
      {
        "path": "name",
        "message": "Invalid input: expected string, received undefined"
      },
      {
        "path": "durationMin",
        "message": "Too small: expected number to be >=0"
      }
    ]
  }
}

レート制限

制限はキーごとに、1 分間のスライディングウィンドウで適用されます。読み取り 240 件、書き込み 60 件です。超えると 429 rate_limited と、秒数を示す Retry-After ヘッダーが返ります。

再試行の前に Retry-After だけ待ち、一括処理は時間を分散し、多くの変更は 1 つのチェンジセットにまとめてください。1 回のリクエストと 1 回の再計算で最大 1,000 件の変更ができます。

レスポンスHTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 12
Content-Type: application/json

{
  "error": "rate_limited",
  "details": {
    "retryAfterSec": 12
  }
}

ページネーションと検索

タスク一覧はカーソルでページ分割されます。limit(1–500、既定値 100)を渡し、次のページでは前のレスポンスの nextCursor を cursor として渡します。nextCursor が null ならページはもうありません。

externalId(独自 ID との完全一致)、q(名前に含む)、updatedSince、completed で絞り込み、sort=-number(新しい順)または -updatedAt で並べ替えます。プロジェクト、メンバー、依存関係などの短い一覧は 1 回のレスポンスで全件返ります。

リクエスト
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?limit=500" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

# next page: pass the nextCursor of the previous response
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?limit=500&cursor=$NEXT_CURSOR" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

バージョン

API と Webhook のペイロードは日付でバージョン管理されます。現在のバージョンは 2026-10-01 で、各イベントの apiVersion フィールドと OpenAPI ドキュメントの info.version に記載されています。

同じバージョン内では追加のみを行います。新しいエンドポイント、新しい任意フィールド、新しいイベントの種類です。新しいバージョンなしにフィールドを削除したり型を変えたりはしないので、知らないフィールドは無視してください。

リクエスト
curl https://planitude.app/api/webhooks/events
レスポンス200 OK
{
  "apiVersion": "2026-10-01",
  "events": [
    "project.created",
    "project.updated",
    "project.deleted",
    "task.created",
    "task.updated",
    "task.deleted",
    "task.completed",
    "task.dates_changed",
    "dependency.created",
    "dependency.deleted",
    "baseline.saved",
    "member.invited",
    "member.joined",
    "comment.created"
  ]
}

API リファレンス

Account

Who is calling, and their workspaces.

User

属性

フィールド型説明
idstring (uuid)
emailstring (email)
namestringnull 可
avatarUrlstringnull 可
localestring
emailVerifiedboolean
オブジェクトUser
{
  "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "email": "anna@example.com",
  "name": "Anna Rossi",
  "avatarUrl": null,
  "locale": "en",
  "emailVerified": true
}

Workspace

属性

フィールド型説明
idstring (uuid)
namestring
rolestring

次のいずれか: owner, admin, member

オブジェクトWorkspace
{
  "id": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "name": "Acme Construction",
  "role": "owner"
}

Current user (connection test)

GET/api/auth/me

読み取り権限のキー

戻り値

200 OK The user

フィールド型説明
userUser
リクエスト
curl https://planitude.app/api/auth/me \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "user": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "email": "anna@example.com",
    "name": "Anna Rossi",
    "avatarUrl": null,
    "locale": "en",
    "emailVerified": true
  }
}

Workspaces of the user, with role

GET/api/workspaces

読み取り権限のキー

戻り値

200 OK Workspaces

フィールド型説明
workspacesarray of Workspace
リクエスト
curl https://planitude.app/api/workspaces \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "workspaces": [
    {
      "id": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "name": "Acme Construction",
      "role": "owner"
    }
  ]
}

API リファレンス

Projects

Projects, templates and baselines.

Project

A project as returned by the write endpoints and project listings.

属性

フィールド型説明
idstring (uuid)
workspaceIdstring (uuid)
keystringProject key, e.g. CRON (task keys are CRON-12).
keyLockedboolean
namestring
descriptionstringnull 可
startDatestring (date)
calendarIdstring (uuid)null 可
currencystring
scheduleFromstring

次のいずれか: forward, backward

deadlinestring (date)null 可
colorstringnull 可
settingsobject
archivedAtstring (date-time)null 可
createdBystring (uuid)null 可
createdAtstring (date-time)
updatedAtstring (date-time)
オブジェクトProject
{
  "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "key": "WHX",
  "keyLocked": false,
  "name": "Warehouse expansion",
  "description": null,
  "startDate": "2026-10-05",
  "calendarId": null,
  "currency": "EUR",
  "scheduleFrom": "forward",
  "deadline": null,
  "color": null,
  "settings": {},
  "archivedAt": null,
  "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z"
}

Template

属性

フィールド型説明
idstringbuiltin:<slug> or the id of a template saved by you.
kindstring

次のいずれか: builtin, user

namestring
descriptionstringnull 可
taskCountinteger
durationDaysintegerWorking days from start to finish.
オブジェクトTemplate
{
  "id": "builtin:website-launch",
  "kind": "builtin",
  "name": "Website launch",
  "description": "From discovery to go-live: design, content, development, testing and launch.",
  "taskCount": 12,
  "durationDays": 43
}

Baseline

属性

フィールド型説明
idstring (uuid)
namestring
indexintegernull 可Numbered MS Project baseline (1-10); null for the main baseline and the ones you name.
capturedAtstring (date-time)
capturedBystring (uuid)null 可
taskCountinteger
オブジェクトBaseline
{
  "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
  "name": "Plan v1",
  "index": null,
  "capturedAt": "2026-10-01T08:30:12.418Z",
  "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "taskCount": 12
}

List projects

GET/api/projects

読み取り権限のキー

All projects visible to the user (not paginated). ?archived=1 includes archived ones.

クエリパラメーター

フィールド型説明
archivedstring

次のいずれか: 1

戻り値

200 OK Projects

フィールド型説明
projectsarray of Project
リクエスト
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "projects": [
    {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "keyLocked": false,
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "calendarId": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "deadline": null,
      "color": null,
      "settings": {},
      "archivedAt": null,
      "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "workspaceName": "Acme Construction",
      "role": "owner",
      "taskCount": 12,
      "finishAt": "2026-10-07T15:00:00.000Z"
    }
  ]
}

Create a project

POST/api/projects

書き込み権限のキー

リクエストボディ

フィールド型説明
name
必須
string
workspaceIdstring (uuid)Defaults to your personal workspace.
keystring2-5 letters/digits, starts with a letter. Derived from the name if omitted.
descriptionstringnull 可
startDatestring (date)
deadlinestring (date)null 可
currencystring
scheduleFromstring

次のいずれか: forward, backward

colorstringnull 可

戻り値

201 Created Created

フィールド型説明
projectProject
リクエスト
curl -X POST https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Warehouse expansion","startDate":"2026-10-05","currency":"EUR"}'
レスポンス201 Created
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  }
}

Create a project from a template

POST/api/projects/from-template

書き込み権限のキー

リクエストボディ

フィールド型説明
templateId
必須
stringId from GET /api/templates.
startDate
必須
string (date)
namestring
keystring
localestringLanguage of the template texts (en, it, es, fr, de, pt, nl, pl, ja, zh, sv, da, no, fi, cs, ro, uk, tr, ar, he, hi, id, vi, ko).
tzstringIANA time zone of the project calendar.
workspaceIdstring (uuid)

戻り値

201 Created Created

フィールド型説明
projectProject
taskCountinteger
conflictsarray of Conflict
リクエスト
curl -X POST https://planitude.app/api/projects/from-template \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "builtin:website-launch",
  "startDate": "2026-10-05",
  "name": "Website relaunch",
  "locale": "en"
}'
レスポンス201 Created
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "taskCount": 12,
  "conflicts": []
}

List project templates

GET/api/templates

読み取り権限のキー

クエリパラメーター

フィールド型説明
localestring

戻り値

200 OK Templates

フィールド型説明
templatesarray of Template
リクエスト
curl https://planitude.app/api/templates \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "templates": [
    {
      "id": "builtin:website-launch",
      "kind": "builtin",
      "name": "Website launch",
      "description": "From discovery to go-live: design, content, development, testing and launch.",
      "taskCount": 12,
      "durationDays": 43
    }
  ]
}

Full project (tasks tree, dependencies, resources, members, baselines)

GET/api/projects/{projectId}

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

戻り値

200 OK Project

フィールド型説明
projectProject
tasksarray of Task
dependenciesarray of Dependency
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ]
}

Update a project

PATCH/api/projects/{projectId}

書き込み権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

リクエストボディ

フィールド型説明
namestring
descriptionstringnull 可
startDatestring (date)
deadlinestring (date)null 可
currencystring
scheduleFromstring

次のいずれか: forward, backward

colorstringnull 可
archivedboolean

戻り値

200 OK Updated

フィールド型説明
projectProject
conflictsarray of Conflict
rescheduledbooleanThe schedule was recalculated (start date, calendar or direction changed).
リクエスト
curl -X PATCH https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deadline":"2026-12-18"}'
レスポンス200 OK
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "conflicts": [],
  "rescheduled": false
}

Export the plan as a file (Microsoft Project XML, CSV, PNG or PDF)

GET/api/projects/{projectId}/export

読み取り権限のキー

Returns the file itself (Content-Disposition: attachment), not JSON. Any role with access to the project, read-only included. png and pdf draw the Gantt chart on the server (title, generation date, legend; in the PDF repeated on every page) and accept the image options below; at most 20 image exports per user every 10 minutes. Over the size limits: 413 limit_exceeded with details.reason (tasks, image_too_large, pages, timeline).

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

クエリパラメーター

フィールド型説明
formatstringFile format. mspdi = Microsoft Project XML.

次のいずれか: mspdi, csv, png, pdf

既定値: mspdi

localestringLanguage of headings, legend and dates (e.g. en, it, ar, ja).

既定値: en

scalestringPNG/PDF: time unit of the columns.

次のいずれか: auto, day, week, month, quarter

既定値: auto

fromstring (date)PNG/PDF: first day to draw (with to). Default: the whole project.
tostring (date)PNG/PDF: last day to draw (with from).
criticalstringPNG/PDF: highlight the critical path.

次のいずれか: 0, 1

既定値: 1

baselinestringPNG/PDF: draw the main baseline under each bar.

次のいずれか: 0, 1

既定値: 1

linksstringPNG/PDF: draw dependency arrows.

次のいずれか: 0, 1

既定値: 1

paperstringPDF: paper size.

次のいずれか: a4, a3, letter

既定値: a4

orientationstringPDF: page orientation.

次のいずれか: landscape, portrait

既定値: landscape

戻り値

200 OK The file: `application/xml`, `text/csv`, `image/png` or `application/pdf`.

リクエスト
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/export?format=pdf&locale=en&paper=a4" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -o plan.pdf

List baselines

GET/api/projects/{projectId}/baseline

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

戻り値

200 OK Baselines

フィールド型説明
baselinesarray of Baseline
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/baseline \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "baselines": [
    {
      "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
      "name": "Plan v1",
      "index": null,
      "capturedAt": "2026-10-01T08:30:12.418Z",
      "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "taskCount": 12
    }
  ]
}

Save a baseline

POST/api/projects/{projectId}/baseline

書き込み権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

リクエストボディ

フィールド型説明
namestring

戻り値

201 Created Saved

フィールド型説明
baselineBaseline
リクエスト
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/baseline \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Plan v1"}'
レスポンス201 Created
{
  "baseline": {
    "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
    "name": "Plan v1",
    "index": null,
    "capturedAt": "2026-10-01T08:30:12.418Z",
    "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "taskCount": 12
  }
}

API リファレンス

Tasks

Tasks, search by external id, comments.

Task

Task representation of GET /tasks and webhook payloads: the stored task (without sortKey) plus project, assignees and link.

属性

フィールド型説明
idstring (uuid)
numberintegerSequential number in the project, never reused.
keystringHuman key, e.g. CRON-12.
parentIdstring (uuid)null 可
namestring
typestring

次のいずれか: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

次のいずれか: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)null 可
deadlinestring (date-time)null 可
calendarIdstring (uuid)null 可
costFixednumber
notesstringnull 可
colorstringnull 可
wbsstringnull 可
externalIdstringnull 可Your identifier for this task in another system. Searchable with GET /tasks?externalId=.
startAtstring (date-time)null 可Computed start.
finishAtstring (date-time)null 可Computed finish.
isCriticalbooleanOn the critical path.
totalFloatMinintegernull 可Total float (slack) in working minutes.
earlyStartAtstring (date-time)null 可
lateFinishAtstring (date-time)null 可
actualStartAtstring (date-time)null 可
actualFinishAtstring (date-time)null 可
actualDurationMinintegernull 可
remainingDurationMinintegernull 可
manuallyScheduledboolean
levelingDelayMininteger
taskTypestring

次のいずれか: fixed_units, fixed_duration, fixed_work, fixed_duration_and_units

effortDrivenboolean
durationOptimisticMinintegernull 可
durationPessimisticMinintegernull 可
projectIdstring (uuid)
completedbooleanprogressPct = 100.
assigneesarray of Assignee
urlstring (uri)Page of the task in the web app.
オブジェクトTask
{
  "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "number": 1,
  "key": "WHX-1",
  "parentId": null,
  "name": "Foundations",
  "type": "task",
  "durationMin": 1440,
  "workMin": 0,
  "progressPct": 0,
  "constraintKind": "asap",
  "constraintDate": null,
  "deadline": null,
  "calendarId": null,
  "costFixed": 0,
  "notes": null,
  "color": null,
  "wbs": null,
  "externalId": "crm-4711",
  "startAt": "2026-10-05T06:00:00.000Z",
  "finishAt": "2026-10-07T15:00:00.000Z",
  "isCritical": true,
  "totalFloatMin": 0,
  "earlyStartAt": "2026-10-05T06:00:00.000Z",
  "lateFinishAt": "2026-10-07T15:00:00.000Z",
  "actualStartAt": null,
  "actualFinishAt": null,
  "actualDurationMin": null,
  "remainingDurationMin": null,
  "manuallyScheduled": false,
  "levelingDelayMin": 0,
  "taskType": "fixed_units",
  "effortDriven": false,
  "durationOptimisticMin": null,
  "durationPessimisticMin": null,
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "completed": false,
  "assignees": [
    {
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "unitsPct": 100
    }
  ],
  "url": "https://planitude.app/app/t/WHX-1"
}

WriteResult

属性

フィールド型説明
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
stats のフィールドを表示
フィールド型説明
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
オブジェクトWriteResult
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Comment

属性

フィールド型説明
idstring (uuid)
taskIdstring (uuid)
userIdstring (uuid)
authorNamestring
authorAvatarUrlstringnull 可
bodystring
mentionsarray of string
createdAtstring (date-time)
editedAtstring (date-time)null 可
オブジェクトComment
{
  "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
  "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "authorName": "Anna Rossi",
  "authorAvatarUrl": null,
  "body": "Concrete delivered, we can start the walls.",
  "mentions": [],
  "createdAt": "2026-10-01T08:30:12.418Z",
  "editedAt": null
}

List or search tasks (paginated)

GET/api/projects/{projectId}/tasks

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

クエリパラメーター

フィールド型説明
limitinteger1-500.

既定値: 100

cursorstringnextCursor of the previous page.
sortstring-number = newest first (polling triggers). -updatedAt returns the first page only.

次のいずれか: number, -number, -updatedAt

既定値: number

externalIdstringExact match on externalId.
qstringName contains (case-insensitive).
updatedSincestring (date-time)
completedstring

次のいずれか: true, false

戻り値

200 OK A page of tasks

フィールド型説明
tasksarray of Task
nextCursorstringnull 可
リクエスト
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?externalId=crm-4711" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null,
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "completed": false,
      "assignees": [
        {
          "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
          "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
          "name": "Anna Rossi",
          "unitsPct": 100
        }
      ],
      "url": "https://planitude.app/app/t/WHX-1"
    }
  ],
  "nextCursor": null
}

Create a task, or apply a change set

POST/api/projects/{projectId}/tasks

書き込み権限のキー

Send a TaskCreate to create one task (201), or a ChangeSet to apply several changes in one transaction (200). Dates are recalculated by the scheduling engine.

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

リクエストボディ

TaskCreate

フィールド型説明
name
必須
string
parentIdstring (uuid)null 可Parent (summary) task; null = top level.
afterTaskIdstring (uuid)null 可Insert after this sibling.
beforeTaskIdstring (uuid)null 可Insert before this sibling.
typestring

次のいずれか: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

次のいずれか: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)null 可
deadlinestring (date-time)null 可
calendarIdstring (uuid)null 可
costFixednumber
notesstringnull 可
colorstringnull 可
wbsstringnull 可
externalIdstringnull 可Your identifier for this task in another system. Searchable with GET /tasks?externalId=.

または ChangeSet

フィールド型説明
createTasksarray of TaskCreate
updateTasksarray of any
createDependenciesarray of DependencyCreate
deleteDependencyIdsarray of string
fullRescheduleboolean

戻り値

201 Created Task created

フィールド型説明
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
stats のフィールドを表示
フィールド型説明
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
リクエスト
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Foundations","durationMin":1440,"externalId":"crm-4711"}'
レスポンス201 Created
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Get a task

GET/api/projects/{projectId}/tasks/{taskId}

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
taskId
必須
string (uuid)Task id.

戻り値

200 OK The task

フィールド型説明
taskTask
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "task": {
    "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "number": 1,
    "key": "WHX-1",
    "parentId": null,
    "name": "Foundations",
    "type": "task",
    "durationMin": 1440,
    "workMin": 0,
    "progressPct": 0,
    "constraintKind": "asap",
    "constraintDate": null,
    "deadline": null,
    "calendarId": null,
    "costFixed": 0,
    "notes": null,
    "color": null,
    "wbs": null,
    "externalId": "crm-4711",
    "startAt": "2026-10-05T06:00:00.000Z",
    "finishAt": "2026-10-07T15:00:00.000Z",
    "isCritical": true,
    "totalFloatMin": 0,
    "earlyStartAt": "2026-10-05T06:00:00.000Z",
    "lateFinishAt": "2026-10-07T15:00:00.000Z",
    "actualStartAt": null,
    "actualFinishAt": null,
    "actualDurationMin": null,
    "remainingDurationMin": null,
    "manuallyScheduled": false,
    "levelingDelayMin": 0,
    "taskType": "fixed_units",
    "effortDriven": false,
    "durationOptimisticMin": null,
    "durationPessimisticMin": null,
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "completed": false,
    "assignees": [
      {
        "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
        "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
        "name": "Anna Rossi",
        "unitsPct": 100
      }
    ],
    "url": "https://planitude.app/app/t/WHX-1"
  }
}

Update a task

PATCH/api/projects/{projectId}/tasks/{taskId}

書き込み権限のキー

Only the fields you send change; null clears a field.

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
taskId
必須
string (uuid)Task id.

リクエストボディ

フィールド型説明
namestring
typestring

次のいずれか: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

次のいずれか: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)null 可
deadlinestring (date-time)null 可
calendarIdstring (uuid)null 可
costFixednumber
notesstringnull 可
colorstringnull 可
wbsstringnull 可
externalIdstringnull 可Your identifier for this task in another system. Searchable with GET /tasks?externalId=.
placementobject
placement のフィールドを表示
フィールド型説明
parentIdstring (uuid)null 可Parent (summary) task; null = top level.
afterTaskIdstring (uuid)null 可Insert after this sibling.
beforeTaskIdstring (uuid)null 可Insert before this sibling.

戻り値

200 OK Updated

フィールド型説明
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
stats のフィールドを表示
フィールド型説明
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
リクエスト
curl -X PATCH https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"progressPct":100}'
レスポンス200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Comments of a task

GET/api/projects/{projectId}/tasks/{taskId}/comments

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
taskId
必須
string (uuid)Task id.

戻り値

200 OK Comments

フィールド型説明
commentsarray of Comment
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/comments \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "comments": [
    {
      "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
      "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "authorName": "Anna Rossi",
      "authorAvatarUrl": null,
      "body": "Concrete delivered, we can start the walls.",
      "mentions": [],
      "createdAt": "2026-10-01T08:30:12.418Z",
      "editedAt": null
    }
  ]
}

Comment on a task

POST/api/projects/{projectId}/tasks/{taskId}/comments

書き込み権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
taskId
必須
string (uuid)Task id.

リクエストボディ

フィールド型説明
body
必須
stringPlain text.
mentionsarray of stringUser ids to notify.

戻り値

201 Created Created

フィールド型説明
commentComment
リクエスト
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/comments \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"Concrete delivered, we can start the walls."}'
レスポンス201 Created
{
  "comment": {
    "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
    "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "authorName": "Anna Rossi",
    "authorAvatarUrl": null,
    "body": "Concrete delivered, we can start the walls.",
    "mentions": [],
    "createdAt": "2026-10-01T08:30:12.418Z",
    "editedAt": null
  }
}

API リファレンス

Dependencies

Links between tasks (FS, SS, FF, SF, with lag).

Dependency

属性

フィールド型説明
idstring (uuid)
predecessorIdstring (uuid)
successorIdstring (uuid)
typestring

次のいずれか: FS, SS, FF, SF

lagMinintegerWorking minutes; negative = lead.
オブジェクトDependency
{
  "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
  "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
  "type": "FS",
  "lagMin": 0
}

List dependencies

GET/api/projects/{projectId}/dependencies

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

戻り値

200 OK Dependencies

フィールド型説明
dependenciesarray of Dependency
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ]
}

Create (or update) a dependency

POST/api/projects/{projectId}/dependencies

書き込み権限のキー

A dependency that would close a cycle is refused with 409 dependency_cycle.

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

リクエストボディ

DependencyCreate

フィールド型説明
predecessorId
必須
string (uuid)
successorId
必須
string (uuid)
typestring

次のいずれか: FS, SS, FF, SF

既定値: FS

lagMininteger

既定値: 0

または dependencies

フィールド型説明
dependencies
必須
array of DependencyCreate

戻り値

201 Created Created

フィールド型説明
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
stats のフィールドを表示
フィールド型説明
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
リクエスト
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
  "type": "FS",
  "lagMin": 0
}'
レスポンス201 Created
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Remove a dependency

DEL/api/projects/{projectId}/dependencies/{dependencyId}

書き込み権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
dependencyId
必須
string (uuid)

戻り値

200 OK Removed

フィールド型説明
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
stats のフィールドを表示
フィールド型説明
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
リクエスト
curl -X DELETE https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies/9ba5faf8-923d-4ecc-86f0-f245c5d179db \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

API リファレンス

People

Project members and task assignees.

Member

属性

フィールド型説明
userIdstring (uuid)
namestring
emailstring
rolestringEffective role on the project.

次のいずれか: owner, editor, viewer

directRolestringnull 可Role granted on the project itself (null = only through the workspace).

次のいずれか: owner, editor, viewer

inheritedbooleanAccess comes from the workspace.
resourceIdstring (uuid)null 可Resource used when the person is assigned to tasks.
addedAtstring (date-time)
avatarUrlstringnull 可
オブジェクトMember
{
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "name": "Anna Rossi",
  "email": "anna@example.com",
  "role": "owner",
  "directRole": null,
  "inherited": false,
  "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
  "addedAt": "2026-10-01T08:30:12.418Z",
  "avatarUrl": null
}

Assignee

属性

フィールド型説明
resourceIdstring (uuid)
userIdstring (uuid)null 可
namestring
unitsPctinteger
オブジェクトAssignee
{
  "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "name": "Anna Rossi",
  "unitsPct": 100
}

Replace the people assigned to a task

PUT/api/projects/{projectId}/tasks/{taskId}/assignees

書き込み権限のキー

userIds must be members of the project (GET /members). An empty list removes everyone. Optional resourceIds replaces the people imported from a file (resources without an account) assigned to the task; omit it to leave them as they are.

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.
taskId
必須
string (uuid)Task id.

リクエストボディ

フィールド型説明
userIds
必須
array of string
resourceIdsarray of string

戻り値

200 OK Assignees saved

フィールド型説明
taskIdstring (uuid)
assignmentsarray of object
assignments のフィールドを表示
フィールド型説明
idstring (uuid)
taskIdstring (uuid)
resourceIdstring (uuid)
unitsPctinteger
workMininteger
resourcesarray of object
resources のフィールドを表示
フィールド型説明
idstring (uuid)
userIdstring (uuid)null 可
namestring
kindstring

次のいずれか: work, material, cost

emailstringnull 可
costPerHournumber
costPerUsenumber
capacityPctinteger
calendarIdstring (uuid)null 可
colorstringnull 可
avatarUrlstringnull 可
needsRescheduleboolean
conflictsarray of Conflict
リクエスト
curl -X PUT https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/assignees \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userIds":["b1666432-132a-4ea9-b1ae-76ea69e226c5"]}'
レスポンス200 OK
{
  "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "assignments": [
    {
      "id": "e62ac96b-e68e-40d3-842e-335e27dfd099",
      "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "unitsPct": 100,
      "workMin": 0
    }
  ],
  "resources": [
    {
      "id": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "kind": "builtin",
      "email": "anna@example.com",
      "costPerHour": 0,
      "costPerUse": 0,
      "capacityPct": 0,
      "calendarId": null,
      "color": null,
      "avatarUrl": null
    }
  ],
  "needsReschedule": false,
  "conflicts": []
}

People with access to the project (assignable)

GET/api/projects/{projectId}/members

読み取り権限のキー

パスパラメーター

フィールド型説明
projectId
必須
string (uuid)Project id.

戻り値

200 OK Members

フィールド型説明
membersarray of Member
rolestring
リクエスト
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/members \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "members": [
    {
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "email": "anna@example.com",
      "role": "owner",
      "directRole": null,
      "inherited": false,
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "addedAt": "2026-10-01T08:30:12.418Z",
      "avatarUrl": null
    }
  ],
  "role": "owner"
}

API リファレンス

Webhooks

Outgoing webhook subscriptions (REST hooks: subscribe/unsubscribe).

Webhook

属性

フィールド型説明
idstring (uuid)
workspaceIdstring (uuid)
workspaceNamestring
projectIdstring (uuid)null 可null = every project of the workspace.
projectNamestringnull 可
namestring
urlstring (uri)
eventsarray of string

次のいずれか: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created

secretPrefixstringFirst characters of the signing secret (not secret).
activeboolean
disabledReasonstringnull 可

次のいずれか: failures, gone, project_deleted, user

disabledAtstring (date-time)null 可
consecutiveFailuresinteger
viaApibooleanCreated with the API (REST hook) rather than from the profile.
createdByobjectnull 可
createdBy のフィールドを表示
フィールド型説明
idstring (uuid)
namestringnull 可
createdAtstring (date-time)
updatedAtstring (date-time)
lastDeliveryAtstring (date-time)null 可
lastSuccessAtstring (date-time)null 可
オブジェクトWebhook
{
  "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "workspaceName": "Acme Construction",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "projectName": "Warehouse expansion",
  "name": "Warehouse sync",
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "secretPrefix": "whsec_Fdwl",
  "active": true,
  "disabledReason": null,
  "disabledAt": null,
  "consecutiveFailures": 0,
  "viaApi": true,
  "createdBy": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z",
  "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
  "lastSuccessAt": "2026-10-01T08:30:12.418Z"
}

Delivery

属性

フィールド型説明
idstring (uuid)
eventIdstring (uuid)
eventTypestring
statusstring

次のいずれか: pending, success, failed, cancelled

attemptsinteger
nextAttemptAtstring (date-time)null 可
lastAttemptAtstring (date-time)null 可
responseStatusintegernull 可
responseExcerptstringnull 可
errorstringnull 可
durationMsintegernull 可
manualboolean
createdAtstring (date-time)
オブジェクトDelivery
{
  "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
  "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "eventType": "task.completed",
  "status": "success",
  "attempts": 1,
  "nextAttemptAt": null,
  "lastAttemptAt": "2026-10-01T08:30:12.418Z",
  "responseStatus": 200,
  "responseExcerpt": "{\"ok\":true}",
  "error": null,
  "durationMs": 39,
  "manual": false,
  "createdAt": "2026-10-01T08:30:12.418Z"
}

Event

属性

フィールド型説明
id
必須
string (uuid)Event id, also in the Planitude-Event-Id header: use it to deduplicate.
type
必須
string

次のいずれか: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created, webhook.ping

apiVersion
必須
string

次のいずれか: 2026-10-01

createdAt
必須
string (date-time)
workspaceId
必須
string (uuid)
projectIdstring (uuid)null 可
actorobjectnull 可Who made the change (null for system changes).
actor のフィールドを表示
フィールド型説明
idstring (uuid)
namestringnull 可
data
必須
object
オブジェクトEvent
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "project.created",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {}
}

Project (event payload)

Compact project representation used in webhook payloads.

属性

フィールド型説明
idstring (uuid)
workspaceIdstring (uuid)
keystring
namestring
descriptionstringnull 可
startDatestring (date)
deadlinestring (date)null 可
currencystring
scheduleFromstring

次のいずれか: forward, backward

colorstringnull 可
archivedboolean
createdAtstring (date-time)
updatedAtstring (date-time)
urlstring (uri)
オブジェクトProject (event payload)
{
  "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "key": "WHX",
  "name": "Warehouse expansion",
  "description": null,
  "startDate": "2026-10-05",
  "deadline": null,
  "currency": "EUR",
  "scheduleFrom": "forward",
  "color": null,
  "archived": false,
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z",
  "url": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8"
}

List webhook subscriptions

GET/api/webhooks

読み取り権限のキー

クエリパラメーター

フィールド型説明
workspaceIdstring (uuid)
projectIdstring (uuid)

戻り値

200 OK Subscriptions

フィールド型説明
webhooksarray of Webhook
リクエスト
curl https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "webhooks": [
    {
      "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "workspaceName": "Acme Construction",
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "projectName": "Warehouse expansion",
      "name": "Warehouse sync",
      "url": "https://example.com/hooks/planitude",
      "events": [
        "task.created",
        "task.completed"
      ],
      "secretPrefix": "whsec_Fdwl",
      "active": true,
      "disabledReason": null,
      "disabledAt": null,
      "consecutiveFailures": 0,
      "viaApi": true,
      "createdBy": {
        "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
        "name": "Anna Rossi"
      },
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
      "lastSuccessAt": "2026-10-01T08:30:12.418Z"
    }
  ]
}

Subscribe (REST hook)

POST/api/webhooks

書き込み権限のキー

Creates a subscription. The response contains the signing secret: it is shown only once. Aliases accepted for automation platforms: targetUrl for url, event for a single event.

リクエストボディ

フィールド型説明
url
必須
string (uri)HTTPS endpoint that receives the events. Public addresses only.
events
必須
array of string* = all events.

次のいずれか: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created, *

namestring
projectIdstring (uuid)Limit to one project (editor role needed). Omit for the whole workspace (owner/admin).
workspaceIdstring (uuid)

戻り値

201 Created Created

フィールド型説明
webhookWebhook
secretstringwhsec_...
リクエスト
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
レスポンス201 Created
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

Event catalog (public)

GET/api/webhooks/events

公開、キー不要

戻り値

200 OK Events

フィールド型説明
apiVersionstring
eventsarray of string
リクエスト
curl https://planitude.app/api/webhooks/events
レスポンス200 OK
{
  "apiVersion": "2026-10-01",
  "events": [
    "project.created",
    "project.updated",
    "project.deleted",
    "task.created",
    "task.updated",
    "task.deleted",
    "task.completed",
    "task.dates_changed",
    "dependency.created",
    "dependency.deleted",
    "baseline.saved",
    "member.invited",
    "member.joined",
    "comment.created"
  ]
}

Get a subscription

GET/api/webhooks/{webhookId}

読み取り権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

戻り値

200 OK Subscription

フィールド型説明
webhookWebhook
リクエスト
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  }
}

Update, pause or resume a subscription

PATCH/api/webhooks/{webhookId}

書き込み権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

リクエストボディ

フィールド型説明
namestring
urlstring (uri)
eventsarray of string
activebooleanfalse = pause; true = resume (also resets the failure counter).

戻り値

200 OK Updated

フィールド型説明
webhookWebhook
リクエスト
curl -X PATCH https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":false}'
レスポンス200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  }
}

Unsubscribe (REST hook)

DEL/api/webhooks/{webhookId}

書き込み権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

戻り値

204 No Content Deleted

リクエスト
curl -X DELETE https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

Delivery log (newest first, kept 30 days)

GET/api/webhooks/{webhookId}/deliveries

読み取り権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

クエリパラメーター

フィールド型説明
limitinteger1-100.

既定値: 50

beforestring (date-time)nextCursor of the previous page.

戻り値

200 OK Deliveries

フィールド型説明
deliveriesarray of Delivery
nextCursorstringnull 可
リクエスト
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "deliveries": [
    {
      "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
      "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
      "eventType": "task.completed",
      "status": "success",
      "attempts": 1,
      "nextAttemptAt": null,
      "lastAttemptAt": "2026-10-01T08:30:12.418Z",
      "responseStatus": 200,
      "responseExcerpt": "{\"ok\":true}",
      "error": null,
      "durationMs": 39,
      "manual": false,
      "createdAt": "2026-10-01T08:30:12.418Z"
    }
  ],
  "nextCursor": null
}

Body sent with a delivery

GET/api/webhooks/{webhookId}/deliveries/{deliveryId}

読み取り権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.
deliveryId
必須
string (uuid)

戻り値

200 OK Payload

フィールド型説明
payloadEvent
リクエスト
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries/4b207161-80f9-40bb-bc3f-d8f70315be00 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "payload": {
    "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "type": "project.created",
    "apiVersion": "2026-10-01",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "actor": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "data": {}
  }
}

Send the same event again

POST/api/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver

書き込み権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.
deliveryId
必須
string (uuid)

戻り値

202 Accepted Queued

フィールド型説明
deliveryDelivery
リクエスト
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries/4b207161-80f9-40bb-bc3f-d8f70315be00/redeliver \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

Send a webhook.ping test event

POST/api/webhooks/{webhookId}/test

書き込み権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

戻り値

202 Accepted Queued

フィールド型説明
deliveryDelivery
リクエスト
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/test \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

Generate a new signing secret

POST/api/webhooks/{webhookId}/rotate-secret

書き込み権限のキー

パスパラメーター

フィールド型説明
webhookId
必須
string (uuid)Webhook id.

戻り値

200 OK New secret (shown once)

フィールド型説明
webhookWebhook
secretstring
リクエスト
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/rotate-secret \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

Webhook

Webhook

Webhook は、何かが変わるとすぐに JSON ボディ付きの HTTPS POST をエンドポイントに送ります。変更元が Web アプリ、API、MCP サーバー、インポートのどれでも同じです。Webhook は 1 つのプロジェクト、またはワークスペースのすべてのプロジェクト(オーナーと管理者)を対象にできます。

プロフィール → Webhookまたは API(REST フック)で作成します。購読は POST /api/webhooks、解除は DELETE です。署名シークレットは一度だけ表示されます。

すべてのリクエストに次のヘッダーが付きます。

ヘッダー説明
Planitude-Signaturet=<unix seconds>,v1=<hex HMAC-SHA256>: see Verify signatures.
Planitude-EventEvent type, e.g. task.completed.
Planitude-Event-IdEvent id, the same in every retry: use it to deduplicate.
Planitude-DeliveryId of this delivery (changes with a manual resend).
User-AgentPlanitude-Webhooks/1.0 (+https://planitude.app/developers)
Content-Typeapplication/json
リクエスト
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
レスポンス201 Created
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

イベントの種類

個別のイベント、またはすべてを受け取る * を購読します。どのイベントも同じエンベロープを持ち、data の内容が種類ごとに変わります。

イベント説明
project.createdA project was created (blank, from a template, duplicated or imported from MS Project).
project.updatedProject fields changed (name, dates, deadline, archive...), or a saved version was restored.
project.deletedA project was deleted.
task.createdA task was created.
task.updatedTask fields or assignees changed. changes lists only the fields that changed.
task.deletedA task was deleted (one event per task of a deleted branch).
task.completedTask progress reached 100%.
task.dates_changedStart or finish moved, because of an edit (cause: edit) or because the schedule was recalculated (cause: reschedule).
dependency.createdA dependency was created or changed.
dependency.deletedA dependency was removed.
baseline.savedA baseline was saved.
member.invitedAn invite link was created for the project.
member.joinedA person joined the project.
comment.createdA comment was added to a task.
ペイロードの例
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "project.created",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {
    "project": {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "deadline": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "color": null,
      "archived": false,
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "url": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8"
    },
    "source": "blank"
  }
}

署名の検証

すべてのリクエストは HMAC-SHA256 と Webhook のシークレットで署名されます。Planitude-Signature ヘッダーにはタイムスタンプ t と署名 v1 が含まれ、署名は t、ドット、未加工のボディから計算されます。

  1. JSON を解析する前の未加工のボディを使います。再シリアライズしたボディは署名が異なります。
  2. HMAC を計算し、定数時間で比較します。
  3. タイムスタンプが手元の時計から 5 分以上ずれたリクエストは拒否します。傍受したリクエストを再送できなくなります。
  4. シークレットはいつでも入れ替えられます。古いものはすぐに使えなくなります。
Verify
import { createHmac, timingSafeEqual } from "node:crypto";

// rawBody: the request body as a string, before JSON.parse
export function verifyPlanitude(rawBody, header, secret, toleranceSec = 300) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const t = Number(parts.t);
  if (!t || Math.abs(Date.now() / 1000 - t) > toleranceSec) return false; // replay
  const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest();
  const given = Buffer.from(parts.v1 ?? "", "hex");
  return given.length === expected.length && timingSafeEqual(given, expected);
}

// Express: app.post("/hooks/planitude", express.raw({ type: "application/json" }), (req, res) => {
//   if (!verifyPlanitude(req.body.toString("utf8"), req.get("Planitude-Signature"), process.env.PLANITUDE_WEBHOOK_SECRET)) return res.sendStatus(400);
//   res.sendStatus(200); // then process the event in a queue
// });

再試行と配信

10 秒以内に任意の 2xx で応答し、実際の処理はその後にキューで行ってください。リダイレクトは追跡しません。エラーやタイムアウトの場合、Planitude は合計 6 回まで試行します。直後、その後 1 min, 5 min, 30 min, 2 h, 12 h の間隔です。

配信は少なくとも 1 回で、順序は保証されません。イベント ID(Planitude-Event-Id、ボディの id)を保存して処理済みのものは飛ばし、順序は createdAt で判断します。

5 件のイベントが連続してすべての試行で失敗すると、Webhook は無効になり、オーナーにメールが届きます。410 Gone を返すとすぐに無効になります。プロフィールから、または PATCH と active: true で再び有効にできます。

配信ログ(ステータス、HTTP コード、レスポンスの抜粋、ペイロード、手動再送)は 30 日間保存されます。宛先には公開アドレスのみ指定できます。

再試行のスケジュール6 × POST
試行 1   直後
試行 2   + 1 min
試行 3   + 5 min
試行 4   + 30 min
試行 5   + 2 h
試行 6   + 12 h

エンドポイントのテスト

  1. テスト用エンドポイント、またはプロフィールのテストボタンで webhook.ping イベントを送ります。
  2. 手元のコンピューターでイベントを受け取るには、トンネル(ngrok や Cloudflare Tunnel など)でローカルサーバーを公開し、その公開 HTTPS アドレスを登録します。
  3. 配信ログでステータス、HTTP コード、レスポンスを確認し、エンドポイントを直したら配信を再送します。
リクエスト
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/test \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
レスポンス202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

AI と MCP

MCP サーバー

Planitude は MCP(Model Context Protocol)サーバーです。AI アシスタントやコードエディターが、あなたの権限でプロジェクトを読み、クリティカルパスや負荷を分析し、タスクを作成・変更します。Web アプリは OAuth で接続し(サインインしてアクセスを許可)、コマンドラインツールやエディターは API キーを使います。

サーバー URL

https://planitude.app/mcp

  • ChatGPTOAuth

    ChatGPT で 設定 › セキュリティとログイン を開き、開発者モードをオンにします。サーバー URL と OAuth 認証でアプリを作成し、Planitude にサインインしてアクセスを許可します。

    公式ドキュメント ↗
  • ClaudeOAuth

    カスタマイズ › コネクタ › カスタムコネクタを追加 を開き、サーバー URL を貼り付けて 接続 を選びます。Planitude が開くのでサインインしてアクセスを許可します。claude.ai、Claude Desktop、モバイルアプリで使えます。

    公式ドキュメント ↗
  • GeminiOAuth

    gemini.google.com で 設定 › 接続済みアプリ を開き、カスタムアプリを追加 を選んでサーバー URL を貼り付けます。その後 Planitude にサインインしてアクセスを許可します。

    公式ドキュメント ↗
  • Claude CodeAPI キー

    キーを環境変数に入れてコマンドを実行します。--scope user を付けるとすべてのプロジェクトで使え、claude mcp list で確認できます。

    公式ドキュメント ↗
  • CodexAPI キー

    キーを PLANITUDE_API_KEY に入れ、~/.codex/config.toml にブロックを追加します。CLI、アプリ、IDE 拡張機能に適用されます。

    公式ドキュメント ↗
  • CursorAPI キー

    ~/.cursor/mcp.json(すべてのプロジェクト)または .cursor/mcp.json(1 つのプロジェクト)にブロックを追加します。Cursor はキーを環境から読み取ります。

    公式ドキュメント ↗
  • ワークスペースに .vscode/mcp.json を追加します。VS Code が一度だけキーを尋ね、ファイルの外に安全に保存します。

    公式ドキュメント ↗
  • Gemini CLIAPI キー

    キーを環境変数に入れてコマンドを実行するか、~/.gemini/settings.json にブロックを追加します。

    公式ドキュメント ↗

ツール

サーバーは読み取りや分析から安全な変更まで 29 個のツールを提供します。プロジェクトやタスクを削除するツールはありません。

read

  • planitude_list_projects
  • planitude_portfolio_overview
  • planitude_get_project
  • planitude_critical_path
  • planitude_delay_impact
  • planitude_monte_carlo
  • planitude_workload
  • planitude_list_baselines
  • planitude_list_versions
  • planitude_list_templates
  • planitude_list_comments
  • planitude_preview_import

write

  • planitude_create_project
  • planitude_create_project_from_template
  • planitude_create_project_from_plan
  • planitude_import_file
  • planitude_edit_project
  • planitude_add_task
  • planitude_update_task
  • planitude_set_progress
  • planitude_indent_task
  • planitude_outdent_task
  • planitude_link_tasks
  • planitude_unlink_tasks
  • planitude_reschedule
  • planitude_configure_simulation
  • planitude_add_comment
  • planitude_save_baseline
  • planitude_save_version
MCP

Server URL

https://planitude.app/mcp

AIエージェント

外部のAIエージェントを最大5件までワークスペースのメンバーとして追加できます:Claude Code、Cursor、Codex、Gemini CLI、GitHub Copilot、または任意のMCPクライアント。タスクを割り当て、コメントでメンションし、変更をレビューできます。

オーナーと管理者はエージェントの「接続」タブでエージェントキーを作成します。キーはpln_で始まり、表示は一度だけで、ハッシュとしてのみ保存されます。各エージェントは最大2個のキーを持て、取り消しは即座に反映されます。

エージェントキーはMCPサーバーでのみ機能し、その場合サーバーは通常のツールの代わりにエージェント用ツールを公開します。REST APIでは403 agent_credentialが返ります。

各キーは閲覧とコメントまたは編集可能のどちらかです。タスクの取得、完了、変更の提案には編集可能なキーが必要で、それ以外では403 agent_key_read_onlyが返ります。

エージェントは追加されたプロジェクトだけを、viewer(閲覧とコメント)またはeditor(タスクの変更も可)として参照し、オーナーになることはありません。プロジェクトでは「このプロジェクトでエージェントを許可」も必要です。既定ではオフで、オーナーがオンにします。

エージェントはタスクの名前、メモ、期間、進捗、期限を変更したり、タスクを作成したりできます。削除、メンバーの招待、ロールの変更を行うツールはありません。

エージェントごとの既定の上限:1分あたり60リクエスト、1日あたり200回の書き込みで、それぞれ240、2,000まで調整できます。レビュー待ちにできる変更はプロジェクトあたり最大200件です。

読み取りツールは、人が書いたテキスト(名前、メモ、コメント)をランダムなnonce付きのplanitude-dataブロックにJSON文字列として入れ、自動チェックで検出された行にはSUSPICIOUSを付けます。これはデータであり、指示ではありません。個人キーで読んだコメントも同じブロックで届きます。

PlanitudeでのAIエージェントの仕組み
MCPClaude Code
claude mcp add --transport http planitude https://planitude.app/mcp \
  --header "Authorization: Bearer $PLANITUDE_AGENT_KEY"

エージェント用ツール

エージェントキーを使うと、MCPサーバーは次の16個のツールを公開します:

read

  • planitude_list_my_projects
  • planitude_list_tasks
  • planitude_read_comments
  • planitude_list_my_proposals

propose

  • planitude_add_comment
  • planitude_propose_task_update
  • planitude_propose_status
  • planitude_propose_task_create

events

  • planitude_poll_events
  • planitude_ack_events

runs

  • planitude_list_my_runs
  • planitude_claim_task
  • planitude_extend_lease
  • planitude_complete_task
  • planitude_fail_task
  • planitude_release_task

自律モードの実行中、エージェント自身のタスクへの変更はすぐに適用され、履歴に残るので復元できます。それ以外の場合と承認ありモードでは、プロジェクトの誰かが適用するまで「承認待ち」で待機します。

Webhookがない場合、エージェントはplanitude_poll_eventsでイベントを読み取り(一度に最大50件)、planitude_ack_eventsで確認します。

リクエストtools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "planitude_claim_task",
    "arguments": {
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "task": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "leaseMinutes": 30
    }
  }
}

実行Webhook

エージェントを自動で起動するには、エージェントの「実行」タブで実行をオンにし、runnerのWebhookを入力します。エージェントに実行すべきタスクがあると、Planitudeが署名付きのPOSTを送ります。シークレットはwhsec_で始まり、表示は一度だけです。URLは公開されたHTTPSアドレスである必要があり、プライベートやローカルのアドレスは拒否されます。

署名、ヘッダー、10秒のタイムアウト、再試行(1 min, 5 min, 30 min, 2 h, 12 h)は他のWebhookと同じです。5回連続で配信に失敗するとWebhookはオフになります。再びオンにするにはURLを保存し直してください。

通知に含まれるのはIDだけで、タスクのテキストは含まれません。エージェントはMCP経由でタスクを読みます。

イベント説明
task.assignedOnly with the “on assignment” trigger: a person assigned the task to the agent. Once per assignment.
task.start_dueDefault trigger: the task’s start date has come (a working day of its calendar).
task.due_todayThe task is due today (deadline or planned finish). Opens a run only if the task never had one.
task.overdueThe task is past its due date, once per due date. Opens a run only if the task never had one.
run.retryThe lease expired without completion, or a person chose Rerun: a new attempt is queued.
run.cancelA run in progress was cancelled (by a person, an emergency stop or the rules): stop working on it.
webhook.pingSent by “Send test event” in the agent’s Execution tab.

newRun: trueを含む通知で実行が始まります。エージェントはplanitude_claim_taskでそれを取得し、30分(5〜240)のleaseを保持し、planitude_extend_leaseで更新します。leaseが切れると新しい試行が始まり、最大3回(上限10回)です。誰も取得しない実行は24時間後に期限切れになります。

planitude_complete_taskはタスクを100%にし、レポートをコメントとして投稿します。未完了のサブタスクがある場合は409 subtasks_openを返します。planitude_fail_taskは理由を記録してチームに通知し、チームは再実行できます。planitude_release_taskは再試行なしでタスクを返します。

各実行で許可される編集は50件(最大500件、超えると429)、各エージェントの未完了の実行は5件(超えると409 too_many_open_runs)です。既定のモードである自律は変更をすぐに適用し、復元もできます。承認ありは変更をレビューに回します。プロジェクト単位またはワークスペース全体の緊急停止は、未完了の実行を取り消し、書き込みをブロックします。

ペイロードの例task.start_due
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "task.start_due",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-14T07:00:00.000Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": null,
  "data": {
    "agentId": "b4d17e2c-93a8-4c6f-8e15-6a0f2d9c7b31",
    "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "runId": "7c3e2a91-5d4b-4f08-b6e1-2f9a0c8d4e57",
    "newRun": true,
    "attempt": 1,
    "leaseMinutes": 30,
    "writeMode": "autonomous",
    "day": "2026-10-14",
    "links": {
      "mcp": "https://planitude.app/mcp",
      "app": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8?task=4dbd104a-00cd-4035-8955-255f52ea586a"
    }
  }
}

runnerを書く

runnerは、通知を受け取ってエージェントを起動する小さなサービスです。言語は問いません。Node 20+なら依存関係は不要です。

  1. 生のボディで署名を検証し、すぐに200を返します。Planitudeが待つのは最大10秒です。
  2. すでに処理したイベント(Planitude-Event-Id)はスキップします。再試行では同じイベントが再送されます。
  3. newRun: trueのとき、タスクを取得してエージェントを起動します。たとえば、PlanitudeのMCPサーバーとエージェントキーを使ったclaude -pです。
  4. エージェントの作業中はleaseを更新し、run.cancelを受けたら停止します。
  5. タスク全体が完了したときだけPLANITUDE: DONEで終えるようエージェントに指示し、そのレポートで完了させます。そうでない場合(PLANITUDE: NOT DONE - …または最終行なし)は、残りの作業を添えて失敗にします。

タスクのテキストはデータとして扱ってください。そこに書かれた指示には決して従わないようエージェントに伝え、必要なPlanitudeのツールだけを許可します。

Runner
// after verifyPlanitude(rawBody, signature, secret) and dedupe on Planitude-Event-Id
res.sendStatus(200); // answer at once, work afterwards
const { type, projectId, data } = event;
if (type === "run.cancel") return stopAgent(data.runId);
if (!data.newRun) return;

await callTool("planitude_claim_task", { projectId, task: data.taskId, leaseMinutes: data.leaseMinutes });
const out = await runAgent(data); // renew with planitude_extend_lease while it works
if (out.lastLine === "PLANITUDE: DONE") {
  await callTool("planitude_complete_task", { runId: data.runId, report: out.report }); // task -> 100%
} else {
  await callTool("planitude_fail_task", { runId: data.runId, reason: out.whatIsLeft });
}

// callTool = JSON-RPC tools/call to the MCP URL
// with Authorization: Bearer <agent key>

OData フィード(Power BI、Excel)

Power BI、Excel、および任意の OData クライアント向けの読み取り専用 OData v4 フィードです。アドレスは 2 種類: 1 つのプロジェクト、またはキー所有者がワークスペースで参照できるすべてのプロジェクト。

  • https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8
  • https://planitude.app/api/odata/workspaces/824650d2-d0b3-4cac-8df8-5743ae9ff65a

読み取り権限を持つ個人用 API キーで認証します: Authorization: Bearer、または Power BI と Excel が提供する方式である HTTP Basic(パスワードにキー、ユーザー名は任意)。OAuth トークンとセッション Cookie は使用できません。1 つのワークスペースに限定されたキーでは、他のワークスペースは読み取れません。

テーブル: Projects, Tasks, Milestones, Dependencies, Resources, Assignments。スキーマは $metadata(CSDL XML)にあり、サービスドキュメントはルートアドレスにあります。

サポートされるオプション: $select、$filter(比較、and/or/not、in、contains、startswith、endswith、tolower、toupper)、$orderby、$top、$skip、$count、/$count。1 ページは既定で 2,000 行、Prefer: odata.maxpagesize で最大 5,000 行です。@odata.nextLink をたどってください。応答には ETag が付きます。If-None-Match を送ると 304 が返ります。$expand、$apply、$search はサポートされていません(400)。

1 つのフィードの上限は 500 プロジェクト、25,000 タスクです(超えると 413)。リクエストはキーの読み取り制限(毎分 240 件)にカウントされます。

Power BI と Excel のステップバイステップガイド
リクエストcURL
curl "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/Tasks?$select=Key,Name,Start,Finish,ProgressPct,IsCritical&$filter=IsCritical&$orderby=Start&$top=2&$count=true" \
  -u "powerbi:$PLANITUDE_API_KEY"

# schema (CSDL XML), for Power BI, Excel and any OData client
curl "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/$metadata" -u "powerbi:$PLANITUDE_API_KEY"
レスポンス200 OK
{
  "@odata.context": "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/$metadata#Tasks(Key,Name,Start,Finish,ProgressPct,IsCritical)",
  "@odata.count": 3,
  "value": [
    {
      "Key": "WHX-2",
      "Name": "Foundations",
      "Start": "2026-10-05T07:00:00Z",
      "Finish": "2026-10-06T15:00:00Z",
      "ProgressPct": 100,
      "IsCritical": true
    },
    {
      "Key": "WHX-3",
      "Name": "Walls",
      "Start": "2026-10-07T07:00:00Z",
      "Finish": "2026-10-09T15:00:00Z",
      "ProgressPct": 50,
      "IsCritical": true
    }
  ]
}

変更履歴

  1. Power BI、Excel、その他の OData クライアント向けに、/api/odata/projects/:projectId と /api/odata/workspaces/:workspaceId で読み取り専用の OData v4 フィードを新たに提供: 6 つのテーブル、$metadata、$select、$filter、$orderby、$top、$skip、$count、サーバー駆動ページング、ETag。

  2. 新しいエンドポイント GET /api/projects/:projectId/export: 計画を Microsoft Project XML、CSV、PNG 画像、PDF で取得できます。目盛り、期間、クリティカル パス、基準計画、依存関係、用紙サイズ、向きを指定できます。

  3. すべてのAPIキーはpln_で始まるようになりました。gnt_で始まるキーは使えなくなりました。新しいキーを作成してください。

  4. エージェントがタスクを実行:署名付きの実行Webhook(task.assigned、task.start_due、task.due_today、task.overdue、run.retry、run.cancel)、lease付きの6つの実行ツール、runnerの書き方ガイド。

  5. MCPの読み取りツールは、人が書いたテキストをnonce付きのplanitude-dataブロックに、SUSPICIOUSマーク付きのJSON文字列として包みます。すべての種類のキーが対象です。

  6. ワークスペースのメンバーとしてのAIエージェント:MCPサーバーでのみ機能するエージェントキー、閲覧・コメント・変更提案のための10個のツール、イベントキュー。

  7. OpenAPI ドキュメントから生成する新しい開発者ドキュメント。OpenAPI ドキュメントは、メンバー、コメント、ベースライン、テンプレート、割り当てで返るすべてのフィールドを記述するようになりました。

  8. API バージョン 2026-10-01: 署名付きの送信 Webhook、文書化された公開 REST API(OpenAPI 3.1)、カーソルによるページネーション、externalId による検索。

  9. MCP サーバーと API に OAuth 2.1。ChatGPT、Claude、Gemini がキーをコピーせずに接続できます。

  10. MCP サーバーと、読み取りまたは読み取りと書き込みの権限を持つ個人用 API キー。

Planitude は広告収入により無料で提供しています