取得できる主な情報の一覧

Backlog API v2 の取得(GET)系の主な API を分類した。パスはすべて https://{ホスト}/api/v2/ に続く部分で、{キー} はプロジェクトのキーまたは ID、{課題} は課題キー(DEV-123)または課題 ID を表す。網羅的な一覧は公式ドキュメントを参照してほしい。

スペース・ユーザー

情報パス補足
スペース情報spaceスペース名、タイムゾーンなど
スペースの最近の更新space/activitiesminId/maxId で取得
スペースの容量の使用状況space/diskUsage管理者のみ
認証ユーザー(自分)users/myself接続確認に使う
ユーザー一覧usersスペースの全ユーザー
ユーザーの最近の活動users/{ユーザーID}/activities数値のユーザーID
チーム一覧teams
レート制限の状況rateLimit種別ごとの上限・残り・リセット時刻
ライセンス(プラン)space/licence使える機能の確認

プロジェクトと設定値

情報パス補足
プロジェクト一覧projectsarchived・all(管理者)で範囲を指定
プロジェクト情報projects/{キー}キー → ID の変換に使う
状態一覧projects/{キー}/statusesカスタム状態を含む
種別一覧projects/{キー}/issueTypesバグ・タスクなど
カテゴリー一覧projects/{キー}/categories
マイルストーン・発生バージョンprojects/{キー}/versions同じ一覧で両方に使う
カスタム属性一覧projects/{キー}/customFieldsID は customField_{ID} の絞り込みに使う
プロジェクトメンバーprojects/{キー}/users担当者の ID を調べる
プロジェクトの最近の活動projects/{キー}/activitiesminId/maxId で取得
優先度一覧prioritiesスペース共通
完了理由一覧resolutionsスペース共通

課題

情報パス補足
課題一覧issuescount(最大100)/offset。レート制限は「検索」
課題数issues/count一覧と同じ絞り込みで件数だけ
課題の詳細issues/{課題}説明(description)を含む
コメント一覧issues/{課題}/commentsminId/maxId。変更履歴は changeLog
コメント数issues/{課題}/comments/count
添付ファイル一覧issues/{課題}/attachments
添付ファイルのダウンロードissues/{課題}/attachments/{添付ID}ファイル名は Content-Disposition
関連する共有ファイルissues/{課題}/sharedFiles
課題の参加者issues/{課題}/participants

Wiki・ドキュメント・ファイル

情報パス補足
Wiki ページ一覧wikis?projectIdOrKey={キー}本文は含まない。レート制限は「検索」
Wiki ページ数wikis/count?projectIdOrKey={キー}
Wiki ページ(本文)wikis/{WikiID}content に本文
Wiki の履歴・タグ・添付wikis/{WikiID}/history、wikis/tags?projectIdOrKey={キー}、wikis/{WikiID}/attachments
ドキュメント一覧・ツリーdocuments、documents/treeドキュメント機能を使っているプロジェクト
共有ファイル一覧projects/{キー}/files/metadata/{フォルダのパス}ルートは files/metadata/
共有ファイルのダウンロードprojects/{キー}/files/{ファイルID}

Git・プルリクエスト・通知

情報パス補足
Git リポジトリ一覧projects/{キー}/git/repositories
プルリクエスト一覧projects/{キー}/git/repositories/{リポジトリ名}/pullRequestsstatusId[] で状態を絞り込む
プルリクエスト数…/pullRequests/count
プルリクエストのコメント…/pullRequests/{番号}/commentsminId/maxId
自分宛ての通知notificationsminId/maxId
ウォッチ一覧users/{ユーザーID}/watchings
最近見た課題・Wikiusers/myself/recentlyViewedIssues、…/recentlyViewedWikis

やりたいこと別の逆引き

やりたいこと方法関連する回
APIキーが正しいか確かめたいusers/myself を呼ぶPART 02
プロジェクトキーから ID を知りたいprojects/{キー} の idPART 04
未完了の課題をすべて取りたい状態一覧から ID 4(完了)以外を集め、statusId[] に渡してページネーションPART 04、PART 05〜09
自分が担当の課題だけassigneeId[]={users/myself の id}PART 05
担当者が未設定の課題API に「未設定」の条件はないので、取得後に assignee が null のものを選ぶPART 04
期限切れの課題未完了の状態 + dueDateUntil={昨日}PART 10
期限日が未入力の課題hasDueDate=false
件数だけ知りたいissues/count(一覧より軽い)PART 07
前回以降に更新された課題だけupdatedSince={前回の日付-1日} + 課題IDで上書きPART 10
課題が完了になった日時コメント一覧の changeLog で field が status の変更を探すPART 07
予定時間と実績時間の比較estimatedHours・actualHours を集計PART 10
親課題だけ・子課題だけparentChild(1:子課題以外、2:子課題 など)下記
カスタム属性で絞り込みたいcustomFields で ID を調べ、customField_{ID} などを付ける下記
添付ファイルをまとめて保存添付ファイル一覧 → 1件ずつダウンロードPART 07
Wiki をバックアップしたいWiki 一覧で ID を集め、wikis/{ID} で本文を1件ずつ取得
マージ待ちのプルリクエストpullRequests?statusId[]=1(1:Open)
Excel のシートに取り込みたいVBA(WinHttp+VBA-JSON)PART 06
スプレッドシートに毎朝取り込みたいGAS+時間主導型トリガーPART 08
利用者ごとの権限で動くツールを作りたいOAuth 2.0PART 03

課題一覧のよく使う絞り込み

パラメータ内容例
projectId[]プロジェクト ID(複数可)projectId[]=12345&projectId[]=67890
statusId[]状態 ID(1 未対応、2 処理中、3 処理済み、4 完了、カスタム状態)statusId[]=1&statusId[]=2
assigneeId[]担当者のユーザー IDassigneeId[]=1073741824
issueTypeId[]・categoryId[]・milestoneId[]種別・カテゴリー・マイルストーン
priorityId[]優先度(priorities で確認)
parentChild0:すべて、1:子課題以外、2:子課題、3:親課題でも子課題でもない、4:親課題(新しい値も追加されている)parentChild=1
keywordキーワード(URL エンコードする)keyword=%E3%83%AD%E3%82%B0%E3%82%A4%E3%83%B3
createdSince/Until登録日の範囲(yyyy-MM-dd)createdSince=2026-10-01
updatedSince/Until更新日の範囲updatedSince=2026-11-01
dueDateSince/Until期限日の範囲dueDateUntil=2026-11-04
hasDueDatefalse で期限日なしの課題(true は指定できない)hasDueDate=false
attachmenttrue で添付ファイルのある課題attachment=true
sort・order並び順。全件取得では created・asc で固定するsort=created&order=asc
count・offset件数(1〜100、既定20)と開始位置count=100&offset=200
customField_{ID}テキスト型のカスタム属性のキーワード。数値・日付型は _min/_max、リスト型は customField_{ID}[]customField_123_min=10

言語別の書き方早見表

処理curl / PowerShellExcel VBAPythonJavaScriptJava(Backlog4j)
APIキー-H "Backlog-API-Key: …" / -Headers @{…}SetRequestHeader "Backlog-API-Key", …session.headers["Backlog-API-Key"]createClient({ host, apiKey })new BacklogComConfigure(id).apiKey(…)
配列パラメータURL に直接(curl は -g)文字列を連結{"statusId[]": [1, 2]}statusId: [1, 2].statusIds(List.of(1L, 2L))
JSON の解析jq / ConvertFrom-JsonVBA-JSON の ParseJsonresp.json()SDK が変換SDK が型に変換
null の扱い// "既定値" / if ($x) {…}IsNull・IsObject(i.get("assignee") or {})i.assignee?.name ?? '…'!= null
ヘッダーの参照-w / $res.Headers[…]GetResponseHeaderresp.headers.get(…)err.response.headers.get(…)直接は不可(HttpClient を使う)
UTC → 日本時間ConvertTo-Jst(PART 05)IsoToJst(PART 06)tz_convert("Asia/Tokyo")toLocaleString(…, { timeZone })atZone(ZoneId.of("Asia/Tokyo"))
Excel で開ける CSV-Encoding utf8BOM(7)(シートに直接書く)encoding="utf-8-sig"先頭に ''先頭に ''
解説PART 05PART 06PART 07PART 08PART 09

エラーコードと対処

エラーの本文 {"errors":[{"message": …, "code": …, "moreInfo": …}]} の code の意味と対処をまとめる。

code名前意味対処
1InternalErrorサーバー側の不具合など少し待って再試行。続くようなら Backlog の障害情報を確認する
2LicenceError今のプランでは使えない機能プランの機能を確認する
3LicenceExpiredErrorライセンスの期限切れスペースの管理者に確認する
4AccessDeniedErrorIP アドレス制限などで拒否された接続元の IP が許可されているか管理者に確認する
5UnauthorizedOperationErrorそのユーザーに権限のない操作キーを発行したユーザーの権限を確認する
6NoResourceError対象が存在しないプロジェクトキー・課題キー・ID の間違い、参加していないプロジェクト
7InvalidRequestErrorパラメータが不正count の範囲、日付の形式(yyyy-MM-dd)、[] の付け忘れを確認する
8SpaceOverCapacityErrorスペースの容量の上限を超える取得では通常起きない
9ResourceOverflowError追加できる数の上限を超える取得では通常起きない
10TooLargeFileErrorファイルが大きすぎる取得では通常起きない
11AuthenticationError認証に失敗したAPIキーの誤り、ドメイン(.com/.jp)の違い
12RequiredMFAError2段階認証が必須のスペースで、ユーザーが2段階認証を有効にしていないキーを発行したユーザーの2段階認証を有効にする
13TooManyRequestsErrorレート制限を超えたX-RateLimit-Reset まで(または1分)待って再試行。並列実行をやめる

HTTP ステータス別の対処

ステータスよくある原因再試行
400パラメータの誤り(code 7)しない
401APIキーの誤り、OAuth 2.0 のトークン切れ(詳細は WWW-Authenticate ヘッダー)トークン切れなら更新してから1回だけ
403権限不足、IP アドレス制限しない
404キーや ID の誤り、参加していないプロジェクトしない
429レート制限(code 13)リセット時刻まで待って再試行
5xxサーバー側の一時的な問題待ち時間を延ばしながら数回

シリーズのまとめ

11回にわたり、Backlog API での情報取得を、APIキーの発行から5つの言語での実装、定期レポートまで扱った。最後に要点を振り返る。

  • APIキーはヘッダー Backlog-API-Key で渡し、コードやブックに直接書かない(PART 02)
  • 利用者ごとの権限で動くツールには OAuth 2.0 を使う(PART 03)
  • 一覧は最大100件。count/offset または minId でページネーションする(PART 04)
  • 状態などは ID で絞り込む。カスタム状態があるので「未完了」は状態一覧から作る
  • 429 は待って再試行し、定期実行では updatedSince とキャッシュで回数を減らす(PART 10)
  • 日時は UTC。期限日は日付だけを使う

AWS のリソースや料金を同じように取得する方法は、boto3 シリーズ で解説している。取得した結果をチャットに流すなら、Google Chat Bot自動投稿シリーズ も参考にしてほしい。

✅ シリーズの目次へ

各回の一覧と、目的別の読み方の案内はシリーズの目次にまとめている。

→ Backlog 情報取得シリーズの目次へ