Garoon APIドキュメント

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

目次

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

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

掲示板のカテゴリー一覧を取得します。

URL

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

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

HTTPメソッド

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

GET

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

パラメーター

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

パラメーター名 型 必須 説明
parentId 数値 省略可 親カテゴリーのID
特殊な値：
  • 1：ルートカテゴリー
  • -1：掲示開始待ちのカテゴリー
  • -2：下書きのカテゴリー
未指定の場合、レスポンスにはルートカテゴリーのみが含まれます。
offset 数値 省略可 取得するカテゴリーの先頭からスキップする数
省略すると、0が設定されます。
limit 数値 省略可 取得するカテゴリーの件数
1から1,000まで指定できます。省略すると100が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/bulletin/categories?parentId=3&offset=0&limit=10

ヘッダー
1
2
3

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

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

ボディ
1
2
3
4
5

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

レスポンス

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

プロパティ
プロパティ名 型 説明
hasNext 真偽値 次のカテゴリー情報があるかどうか
  • true：次のカテゴリーが情報がある
  • false：次のカテゴリー情報がない
categories 配列 カテゴリーの一覧
PC画面の表示順に並びます。
categories[].id 文字列 カテゴリーID
categories[].name 文字列 カテゴリー名
値の言語はAPIを実行するユーザーの言語設定に応じます。
categories[].description 文字列 カテゴリーのメモ
メモがない場合はnullが返ります。
categories[].hasSubCategories 真偽値 子カテゴリーが存在するかどうか
  • 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

{
  "hasNext": false,
  "categories": [
    {
      "id": "3",
      "name": "Category1",
      "description": null,
      "hasSubCategories": true
    },
    {
      "id": "4",
      "name": "Category2",
      "description": "memo",
      "hasSubCategories": false
    },
    {
      "id": "5",
      "name": "Category3",
      "description": "memo",
      "hasSubCategories": false
    }
  ]
}

サンプルコード

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

curlを使ったリクエスト

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

1
2

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

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

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