---
updatedAt: 2026-04-27T13:21:44.000Z
agentTools:
  projectIndex: https://developers.karte.io/llms.txt
---

# Get jobflow.

KARTE Datahub から Jobflow を取得します。

#### Required Scope
APIの実行に必要なScopeです。
```
datahub.jobflow.get
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Datahub > データの閲覧
```


# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.karte.io",
      "description": "Production server"
    },
    {
      "url": "https://api-jp.karte.io",
      "description": "Production JP server. リージョン固定オプションのプロジェクトはこちらのエンドポイントを利用してください."
    }
  ],
  "info": {
    "version": "2.0.0",
    "title": "Datahub"
  },
  "paths": {
    "/v2/datahub/jobflow/get": {
      "post": {
        "tags": [
          "Jobflow"
        ],
        "summary": "Get jobflow.",
        "description": "KARTE Datahub から Jobflow を取得します。\n\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\ndatahub.jobflow.get\n```\n\n#### Required Role\n管理画面でScopeを追加する際に必要な権限です。\n```\nDatahub > データの閲覧\n```\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "jobflow_id": {
                    "$ref": "#/components/schemas/JobflowId"
                  }
                },
                "required": [
                  "jobflow_id"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "ジョブフローの ID"
                    },
                    "name": {
                      "type": "string",
                      "description": "ジョブフロー名"
                    },
                    "status": {
                      "type": "string",
                      "description": "ジョブフローのステータス\nstatus は以下のようにジョブフローの状態を示します。\n- READY: 待機中\n- RUNNING: 実行中\n- DONE: 実行済\n- ERROR: エラー\n- STOPPED: 停止済\n- STOPPING: 停止中\n"
                    },
                    "archived": {
                      "type": "boolean",
                      "description": "ジョブフローがアーカイブされているか"
                    },
                    "author": {
                      "type": "string",
                      "description": "ジョブフローの作成者"
                    },
                    "created": {
                      "type": "string",
                      "description": "ジョブフローが作成された日時(タイムゾーンはUTC)"
                    },
                    "error_message": {
                      "type": "string",
                      "description": "ジョブフローの実行時にエラーが発生した場合のエラーメッセージ。status が ERROR の場合にのみ含まれます。"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "status",
                    "archived",
                    "created"
                  ],
                  "example": {
                    "id": "615e952b88c9930012bd7cbc",
                    "name": "import",
                    "status": "DONE",
                    "archived": false,
                    "author": "karte@plaid.co.jp",
                    "created": "2021-01-01T12:12:12.000Z"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "x-karte-api",
            "schema": {
              "type": "string"
            },
            "description": "今後利用する可能性のある予約語です。現在は設定不要です。"
          },
          {
            "in": "header",
            "name": "authorization",
            "schema": {
              "type": "string"
            },
            "description": "認証情報を含むトークンです。\"Authorization\" ヘッダーに `Bearer <token>` の形式で設定してください。"
          },
          {
            "in": "header",
            "name": "content-type",
            "schema": {
              "type": "string"
            },
            "description": "リクエストのコンテンツタイプを指定します。通常は `application/json` を使用してください。"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "JobflowId": {
        "type": "string",
        "description": "取得する対象のジョブフローの ID\n※ IDはジョブフロー管理画面のURLから取得できます。 ***https://admin.karte.io/datahub/jobflow/each/{jobflow_id}***\n"
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-explorer-enabled": false
}
````