Garoon API

1件の申請データを取得する

目次

1件の申請データを取得する(2026年4月の定期メンテナンス後より適用されます)

申請IDで指定して、1件の申請データを取得します。

URL

https://sample.cybozu.com/g/api/v1/workflow/requests/REQUEST_ID

パスパラメーター
パラメーター名 説明
REQUEST_ID 取得するワークフローの申請ID

HTTPメソッド

GET

利用できるバージョン

  • クラウド版Garoon

必要なアクセス権

指定した申請データへのアクセス権が必要です。

リクエスト

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/g/api/v1/workflow/requests/2

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。

レスポンス

処理が成功すると、ワークフローの申請データがJSON形式で返ります。
詳細は ワークフローオブジェクト を確認してください。

  • folderavailableOperationsは取得できません。
  • 次のプロパティとしてGaroonユーザーIDを取得できます。
    • applicant.id
    • applicant.proxy.id
    • steps.ステップ.processors[].id
    • steps.ステップ.processors[].proxy.id
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "id": "1",
  "status": {
    "name": "進行中",
    "type": "IN_PROGRESS"
  },
  "createdAt": "2025-11-28T05:27:45Z",
  "processingStepCode": "$3",
  "name": "仮払申請(カンファレンスチケット費用)",
  "number": "request-1",
  "isUrgent": true,
  "applicant": {
    "id": "100",
    "code": "sato",
    "name": "佐藤 昇",
    "proxy": {
      "id": "123",
      "code": "sato2",
      "name": "佐藤 降"
    },
    "form": {
      "id": "123",
      "name": "費用申請"
    }
  },
  "items": {
    "Item1": {
      "name": "Item1 name",
      "type": "SINGLE_LINE_TEXT",
      "value": "foo"
    },
    "Item2": {
      "name": "Item2 name",
      "type": "MULTI_LINE_TEXT",
      "value": "foo"
    }
  },
  "steps": {
    "Step1": {
      "id": 15,
      "name": "課長承認",
      "requirement": "承認(全員)",
      "isApprovalStep": 1,
      "processors": [
        {
          "id": "102",
          "code": "matsuda",
          "name": "松田 かんな",
          "result": "Approved",
          "operatedAt": "2022-09-28T06:13:15Z",
          "comment": "確認しました。"
        },
        {
          "id": "101",
          "code": "takahashi",
          "name": "高橋 健一",
          "result": "Approved",
          "operatedAt": "2022-09-28T06:13:15Z",
          "comment": "代理で確認しました。",
          "proxy": {
            "id": "10",
            "code": "yamadas",
            "name": "山田 正一"
          }
        }
      ]
    },
    "Step2": {
      "id": "16",
      "name": "部長承認",
      "requirement": "承認(全員)",
      "isApprovalStep": 1,
      "processors": [
        {
          "id": "105",
          "code": "suzuki",
          "name": "鈴木 孝充"
        },
        {
          "id": "103",
          "code": "ito",
          "name": "伊東 美咲"
        }
      ]
    }
  }
}

サンプルコード

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
curl -X GET 'https://sample.cybozu.com/g/api/v1/workflow/requests/2' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1
await garoon.api('/api/v1/workflow/requests/2', 'GET', {});