Backlog API で課題一覧を取得し CSV 出力する手順｜Python の実装例

https://xxxx.backlog.com/EditApiSettings.action

export BACKLOG_API_KEY="あなたのAPIキー"
export BACKLOG_SPACE_ID="xxxxx"

pip install requests

import os
import pprint
import requests

# 環境変数から認証情報を読み込む
API_KEY = os.environ["BACKLOG_API_KEY"]
SPACE_ID = os.environ["BACKLOG_SPACE_ID"]   # 例: xxxxx（https://xxxxx.backlog.com の xxxxx 部分）
DOMAIN = "backlog.com"                       # .backlog.jp / .backlogtool.com の場合は変更する
PROJECT_ID = 12345                           # 確認したプロジェクト ID（数値）

def main（）:
    url = f"https://{SPACE_ID}.{DOMAIN}/api/v2/issues"
    params = {
        "apiKey": API_KEY,
        "projectId[]": [PROJECT_ID],   # 配列で指定する
        "count": 20,                   # 取得件数（既定 20、最大 100）
    }

    try:
        response = requests.get（url, params=params）
        response.raise_for_status（）    # エラーがあれば例外を発生させる
        issues = response.json（）
        pprint.pprint（issues）
    except requests.exceptions.RequestException as e:
        print（f"エラーが発生しました: {e}"）

if __name__ == "__main__":
    main（）

import os
import time
import requests

API_KEY = os.environ["BACKLOG_API_KEY"]
SPACE_ID = os.environ["BACKLOG_SPACE_ID"]
DOMAIN = "backlog.com"
PROJECT_ID = 12345

def fetch_all_issues（extra_params=None）:
    """課題を全件取得して 1 つのリストにまとめて返す"""
    url = f"https://{SPACE_ID}.{DOMAIN}/api/v2/issues"
    count = 100          # 1 回の最大取得件数
    offset = 0
    all_issues = []

    while True:
        params = {
            "apiKey": API_KEY,
            "projectId[]": [PROJECT_ID],
            "count": count,
            "offset": offset,
            "sort": "dueDate",
            "order": "asc",
        }
        # 絞り込み条件などを追加で渡せるようにする
        if extra_params:
            params.update（extra_params）

        response = requests.get（url, params=params）
        response.raise_for_status（）
        issues = response.json（）

        all_issues.extend（issues）

        # 取得件数が count 未満なら最後のページ
        if len（issues） < count:
            break

        offset += count
        time.sleep（1）    # レート制限に配慮して間隔を空ける

    return all_issues

if __name__ == "__main__":
    issues = fetch_all_issues（）
    print（f"取得した課題数: {len（issues）} 件"）

def fetch_open_status_ids（）:
    """プロジェクトのステータスから「完了」以外の ID を返す（カスタムステータス対応）"""
    url = f"https://{SPACE_ID}.{DOMAIN}/api/v2/projects/{PROJECT_ID}/statuses"
    params = {"apiKey": API_KEY}

    response = requests.get（url, params=params）
    response.raise_for_status（）
    statuses = response.json（）

    CLOSED_STATUS_ID = 4   # 初期ステータスの「完了」
    # 完了（4）以外を未完了として扱う（カスタムステータスも自動的に含まれる）
    return [s["id"] for s in statuses if s["id"] != CLOSED_STATUS_ID]

import csv

def export_high_priority_issues（output_file="high_priority_issues.csv"）:
    # 完了以外のステータス ID を動的に取得する
    open_status_ids = fetch_open_status_ids（）

    extra_params = {
        "statusId[]": open_status_ids,   # 完了以外（カスタムステータス含む）
        "priorityId[]": [2],             # 優先度: 高
    }

    issues = fetch_all_issues（extra_params）

    if not issues:
        print（"条件に一致する課題はありませんでした。"）
        return

    # encoding="utf_8_sig" で Excel の文字化けを防ぐ
    with open（output_file, "w", encoding="utf_8_sig", newline=""） as f:
        fieldnames = ["課題キー", "件名", "担当者", "ステータス", "優先度", "期限日", "詳細URL"]
        writer = csv.DictWriter（f, fieldnames=fieldnames）
        writer.writeheader（）

        for issue in issues:
            # 担当者が未設定の場合に備える
            assignee = issue["assignee"]["name"] if issue.get（"assignee"） else "（未設定）"

            writer.writerow（{
                "課題キー": issue["issueKey"],
                "件名": issue["summary"],
                "担当者": assignee,
                "ステータス": issue["status"]["name"],
                "優先度": issue["priority"]["name"],
                "期限日": issue["dueDate"] if issue.get（"dueDate"） else "（指定なし）",
                "詳細URL": f"https://{SPACE_ID}.{DOMAIN}/view/{issue['issueKey']}",
            }）

    print（f"'{output_file}' に {len（issues）} 件の課題を出力しました。"）

if __name__ == "__main__":
    export_high_priority_issues（）

import csv

def export_projects（output_file="projects.csv"）:
    url = f"https://{SPACE_ID}.{DOMAIN}/api/v2/projects"
    params = {"apiKey": API_KEY}

    response = requests.get（url, params=params）
    response.raise_for_status（）
    projects = response.json（）

    with open（output_file, "w", encoding="utf_8_sig", newline=""） as f:
        fieldnames = ["プロジェクトID", "プロジェクトキー", "プロジェクト名"]
        writer = csv.DictWriter（f, fieldnames=fieldnames）
        writer.writeheader（）

        for p in projects:
            writer.writerow（{
                "プロジェクトID": p["id"],
                "プロジェクトキー": p["projectKey"],
                "プロジェクト名": p["name"],
            }）

    print（f"'{output_file}' に {len（projects）} 件のプロジェクトを出力しました。"）