Garoon APIドキュメント

掲示板のカテゴリー内の掲示一覧を取得する

目次

掲示板のカテゴリー内の掲示一覧を取得する（2025年9月定期メンテナンス後より適用されます）

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

掲示版のカテゴリーIDを指定して、カテゴリー内の掲示一覧を取得します。

URL

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

https://sample.cybozu.com/g/api/v1/bulletin/categories/CATEGORY_ID

パスパラメーター
パラメーター名 説明
CATEGORY_ID 取得する掲示板のカテゴリーID

HTTPメソッド

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

GET

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

パラメーター

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

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

https://sample.cybozu.com/g/api/v1/bulletin/categories/1

ヘッダー
1
2
3

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

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

ボディ
1
2
3
4

{
  "offset": 0,
  "limit": 10
}

レスポンス

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

プロパティ
プロパティ名 型 説明
hasNext 真偽値 次のカテゴリー情報があるかどうか
  • true：次のカテゴリーが情報がある
  • false：次のカテゴリー情報がない
topics 配列 掲示一覧
topics[].id 文字列 掲示板のID
topics[].subject 文字列 掲示板のタイトル
topics[].updatedAt 文字列 更新日時
topics[].updater オブジェクト 掲示板の更新者情報
topics[].updater.id 文字列 更新者のGaroonユーザーID
topics[].updater.code 文字列 更新者のログイン名
topics[].updater.name 文字列 更新者の表示名
topics[].manuallySender 文字列 直接入力された差出人名
レスポンスの例
 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

{
    "hasNext": false,
    "topics": [
        {
            "id": "3",
            "subject": "but2",
            "updatedAt": "2025-06-09T16:45:05+09:00"
            "updater": {
                "id": "1",
                "code": "Administrator",
                "name": "Administrator"
            },
        },
        {
            "id": "2",
            "subject": "but1",
            "updatedAt": "2025-06-09T16:44:08+09:00"
            "updater": {
                "id": "1",
                "code": "Administrator",
                "name": "Administrator"
            },
        },
        {
            "id": "1",
            "subject": "but3",
            "updatedAt": "2025-06-10T11:56:04+09:00",
            "manuallySender": "Manual User Input"
        }      
    ]
}

サンプルコード

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

curlを使ったリクエスト

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

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/bulletin/categories/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1
2
3
4
5
6

const body = {
  offset: 0,
  limit: 10
};

await garoon.api('/api/v1/bulletin/categories/1', 'GET', body);