予定のコメントを取得する

目次

予定のコメントを取得する(このAPIは2026年9月の定期メンテナンス後より適用されます)

予定IDを指定して、予定に書き込まれたコメントの一覧を取得します。

URL

https://sample.cybozu.com/g/api/v1/schedule/events/SCHEDULE_ID/comments

パスパラメーター
パラメーター名 説明
SCHEDULE_ID コメントを取得する予定の予定ID

HTTPメソッド

GET

利用できるバージョン

  • クラウド版Garoon

必要なアクセス権

  • 予定の閲覧権限

非公開の予定のコメントを取得できるのは、予定の参加者と共有先のユーザーだけです。

リクエスト

パラメーター

リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、 Garoon REST APIリクエストを送信するAPI を使って実行する場合は、リクエストボディとして指定できます。

パラメーター名 必須 説明
limit 数値 省略可 取得するコメントの件数
1,000まで指定できます。省略すると100が設定されます。
offset 数値 省略可 取得するコメントの先頭からスキップする数
省略すると、0が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/events/123/comments?limit=30

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

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

レスポンス

プロパティ
プロパティ名 説明
comments 配列 コメントの一覧
createdAtの降順で返ります。
comments[].id 文字列 コメントID
comments[].body 文字列 コメントの本文
ユーザーが入力した文字列が、HTMLエスケープされずに返ります。
comments[].createdAt 文字列 コメントを書き込んだ日時
UTCのISO 8601形式で返ります。
例:2024-04-19T04:46:25Z
comments[].creator オブジェクト コメントを書き込んだユーザーの情報
comments[].creator.id 文字列 コメントを書き込んだユーザーのGaroonユーザーID
ユーザーが削除されている場合は、空文字が返ります。
comments[].creator.code 文字列 コメントを書き込んだユーザーのログイン名
ユーザーが削除されている場合は、空文字が返ります。
comments[].creator.name 文字列 コメントを書き込んだユーザーの表示名
ユーザーが削除されている場合は、Username(Deleted)のように削除済みであることを示す文字列付きの表示名が返ります。
comments[].mentions 配列 コメント内で宛先に指定されたユーザー、組織、またはロールの一覧
宛先の指定がない場合は、空配列が返ります。
comments[].mentions[].type 文字列 宛先の種類
次のいずれかの値が返ります。
  • USER:ユーザー
  • ORGANIZATION:組織
  • ROLE:ロール
  • ALL:予定のすべての参加者
comments[].mentions[].id 文字列 宛先のID
宛先が削除されている場合は、空文字が返ります。
typeALLの場合は、allが返ります。
comments[].mentions[].code 文字列 宛先のコード
宛先が削除されている場合、およびtypeALLの場合は、空文字が返ります。
comments[].mentions[].name 文字列 宛先の表示名
typeALLの場合は、Attendeesが返ります。
hasNext 真偽値 次のコメントがあるかどうか
  • true:次のコメントがある
  • false:次のコメントがない
レスポンスの例
 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
{
  "comments": [
    {
      "id": "1",
      "body": "Please confirm your attendance.",
      "createdAt": "2024-04-19T04:46:25Z",
      "creator": {
        "id": "4",
        "code": "user1",
        "name": "Aki Tanaka"
      },
      "mentions": [
        {
          "type": "USER",
          "id": "5",
          "code": "user2",
          "name": "Haru Yamada"
        }
      ]
    },
    {
      "id": "2",
      "body": "Got it, I will attend.",
      "createdAt": "2024-04-19T05:10:00Z",
      "creator": {
        "id": "5",
        "code": "user2",
        "name": "Haru Yamada"
      },
      "mentions": []
    }
  ],
  "hasNext": false
}

サンプルコード

curlを使ったリクエスト

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

1
2
curl -X GET 'https://sample.cybozu.com/g/api/v1/schedule/events/123/comments?limit=30' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1
2
3
4
5
const body = {
  limit: 30
};

await garoon.api('/api/v1/schedule/events/123/comments', 'GET', body);

公式コミュニティ

kintone開発者同士で質問や知見を共有し、学び合うことができます。