テンプレート一覧の取得

GET /file/designs エンドポイントは、ワークスペース内のテンプレート（デザイン）の一覧を返します。PDF 生成に使うテンプレート ID（designId）と最新バージョンを、管理画面を開かずにプログラムから調べられます。MCP サーバーなど、利用者にテンプレートを選ばせる連携で使われています。

エンドポイント情報

• URL: https://api.re-port-flow.com/v1/file/designs
• メソッド: GET
• 認証: appkey ヘッダー、または OAuth 2.0 のアクセストークン（認証方法）
• レート制限: 100 リクエスト / 分（ワークスペース単位）

使用例

cURL

# 1 ページ目（先頭 30 件）
curl -X GET https://api.re-port-flow.com/v1/file/designs \
  -H "appkey: your-application-key"

# 2 ページ目
curl -X GET "https://api.re-port-flow.com/v1/file/designs?page=2" \
  -H "appkey: your-application-key"

パラメータ

パラメータ	場所	必須	説明
page	クエリ	いいえ	ページ番号（1 始まり）。省略時は 1 ページ目。1 ページあたりの件数は 30 件固定です

レスポンス

成功時 (200 OK)

{
  "designs": [
    {
      "id": "0eUDdgAjNXrrItA2",
      "label": "請求書",
      "latestVersion": 3,
      "thumbnail": "https://...",
      "updatedAt": "2026-10-01T09:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

値は説明用の例です。

フィールド	型	説明
designs[].id	string	テンプレート ID（16 文字の英数字）。PDF 生成の designId に使います
designs[].label	string	テンプレート名
designs[].latestVersion	integer	最新バージョン番号
designs[].thumbnail	string	サムネイル URL
designs[].updatedAt	string（date-time）	最終更新日時
total	integer	総件数
page	integer	現在のページ番号（1 始まり）
pageSize	integer	1 ページあたりの件数（30 件固定）
totalPages	integer	総ページ数

全件を取得するときは、page を 1 から totalPages まで順に増やして呼び出します。

エラー時

400 / 401 / 403 / 412 / 429 / 500 を返すことがあります。認証ヘッダーが無い場合は 412 です。各ステータスの code と対処は エラーコード一覧 を参照してください。

次のステップ

• テンプレートのパラメータ取得 - 選んだテンプレートに渡すパラメータの構造を調べる
• 単一PDF同期生成 - テンプレート ID とパラメータで PDF を生成する