5 分で API を叩き始める。

CLI をインストールして、ワークスペースに認証し、最初のプロジェクトを作成します。

# Install the DevFlow CLI
npm install -g @devflow/cli

# Authenticate
devflow auth login

# Create a project
devflow projects create "Apollo redesign" --workspace acme

数秒で 1 つ目のプロジェクトが立ち上がります。続いて issue や sprint を載せていきます。

API は Bearer トークンで認証します。ライブ用とテスト用の 2 種類があり、ダッシュボードから発行・失効できます。

curl https://api.devflow.dev/v1/projects \
  -H "Authorization: Bearer df_live_••••••" \
  -H "Content-Type: application/json"

# 200 OK
{
  "data": [
    { "id": "prj_8h2k1", "name": "Apollo redesign", "status": "active" }
  ],
  "next_cursor": null
}

ヒント: テスト用トークン (df_test_...) はサンドボックス環境のみで動作します。

プロジェクトの作成・更新・削除は POST/PATCH/DELETE で対称に揃えてあります。ペイロードは最小限で、ワークスペース ID とオーナー email だけで作れます。

POST /v1/projects
{
  "name": "Apollo redesign",
  "workspace_id": "ws_a1b2c3",
  "owner_email": "lead@acme.dev",
  "due_date": "2026-09-15"
}

# 201 Created
{
  "id": "prj_8h2k1",
  "name": "Apollo redesign",
  "status": "active",
  "created_at": "2026-06-14T05:12:03Z"
}

Issue は Project に属し、status は backlog / in_progress / done の 3 つです。API で作成・更新・状態遷移ができ、担当者と優先度 (low / medium / high) を持てます。

POST /v1/issues
{
  "project_id": "prj_8h2k1",
  "title": "Fix login redirect loop",
  "assignee_email": "dev@acme.dev",
  "priority": "high",
  "status": "in_progress"
}

# 201 Created
{
  "id": "iss_71c",
  "project_id": "prj_8h2k1",
  "title": "Fix login redirect loop",
  "status": "in_progress",
  "priority": "high",
  "created_at": "2026-06-14T05:13:40Z"
}

ヒント: status を done に更新すると issue.updated Webhook が飛びます。

Sprint は期間を区切った issue のまとまりです。issue を追加し、終了すると velocity (完了ポイント) が記録されます。

POST /v1/sprints
{
  "project_id": "prj_8h2k1",
  "name": "Sprint 14",
  "starts_on": "2026-06-16",
  "ends_on": "2026-06-29"
}

# 201 Created
{ "id": "spr_4a9", "name": "Sprint 14", "status": "active", "issue_count": 0 }

# Add an issue to the sprint
POST /v1/sprints/spr_4a9/issues  { "issue_id": "iss_71c" }

課金や CI 連携などの自動化のため、主要なイベントを Webhook で受け取れます。受信エンドポイントは https のみ受け付けます。

プランごとに 1 分あたりのリクエスト上限が決まっています。上限到達時は 429 を返します。

• Free — 60 requests / min
• Team — 600 requests / min
• Enterprise — custom

一覧 API は cursor ベースです。limit は最大 100 (既定 50)。レスポンスの next_cursor を次のリクエストの cursor に渡すと次ページを取得できます。

GET /v1/issues?project_id=prj_8h2k1&limit=50

# Response includes next_cursor; pass it back for the next page
GET /v1/issues?project_id=prj_8h2k1&limit=50&cursor=eyJpZCI6Imlzc183MWMi...

公式 SDK は TypeScript / Python / Go の 3 言語。認証、ページング、リトライ、Webhook の署名検証まで一通り組み込まれています。