Garoon APIドキュメント

メッセージ一覧を取得する

目次

メッセージ一覧を取得する

固定リンクがコピーされました

管理者権限でメッセージの一覧を取得します。

URL

固定リンクがコピーされました

クラウド版

https://sample.cybozu.com/g/api/v1/message/admin/messages

HTTPメソッド

固定リンクがコピーされました

GET

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon

必要なアクセス権

固定リンクがコピーされました

リクエスト

固定リンクがコピーされました

パラメーター

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

パラメーター名 型 必須 説明
offset 数値 省略可 取得するファイルの先頭からスキップする数
省略すると、0が設定されます。
limit 数値 省略可 取得するファイル数の上限
1から1,000まで指定できます。省略すると100が設定されます。
rangeStart 文字列 省略可 メッセージの取得期間（開始日時）
rangeStartで指定した日時より後に開始する予定に絞り込みます。
RFC 3339形式で指定します。
たとえば、日本時間の2024年10月19日9時10分30秒を指定したい場合には、次のように指定します。
  • UTCで指定する場合：「2024-10-19T00:10:30Z」
  • JSTで指定する場合：「2024-10-19T09:10:30+09:00」
rangeEndを指定する場合には、rangeEndより前の値を指定してください。
rangeEnd 文字列 省略可 メッセージの取得期間（終了日時）
rangeEndで指定した日時より前に終了した予定に絞り込みます。
RFC 3339形式で指定します。
rangeStartを指定する場合には、rangeStartより後の値を指定してください。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/message/admin/messages

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
messages 配列（オブジェクト） メッセージの一覧
messages[].id 文字列 メッセージのID
messages[].subject 文字列 メッセージの標題
messages[].creator[].id 文字列 作成者のGaroonユーザーID
messages[].creator[].name 文字列 作成者の表示名
messages[].creator[].code 文字列 作成者のログイン名
messages[].updater[].id 文字列 更新者のGaroonユーザーID
messages[].updater[].name 文字列 更新者の表示名
messages[].updater[].code 文字列 更新者のログイン名
messages[].createdAt 文字列 作成日時
messages[].updatedAt 文字列 更新日時
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

{
    "messages": [
        {
            "id": "37",
            "subject": "This is title of message1",
            "creator": {
                "id": "1",
                "name": "Administrator",
                "code": "Administrator"
            },
            "updater": null,
            "createdAt": "2024-11-29T07:16:06Z",
            "updatedAt": "2024-11-29T07:16:06Z"
        },
        {
            "id": "36",
            "subject": "This is title of message2",
            "creator": {
                "id": "1",
                "name": "Administrator",
                "code": "Administrator"
            },
            "updater":  {
                "id": "1",
                "name": "Administrator",
                "code": "Administrator"
            },
            "createdAt": "2024-11-29T07:15:36Z",
            "updatedAt": "2024-11-29T07:15:36Z"
        }
    ],
    "hasNext": false
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト

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

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/message/admin/messages' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1

await garoon.api('/api/v1/message/admin/messages', 'GET', {});