Contents
フォルダ一覧取得
フォルダ一覧を取得します。
メソッド
GET
URL
https://cacoo.com/api/v1/folders.format
例 : https://cacoo.com/api/v1/folders.json
フォーマット
json, xml
認証
必須
パラメーター
パラメータ名 | 型 | 内容 | 例 |
---|---|---|---|
organizationKey(必須) | 文字列 | Organizations API で取得した組織のキー | abcdefghij |
*旧プラン(旧フリープラン・プラスプラン)をご利用の場合、パラメーターにorganizationKey
は不要です。
レスポンス
フィールド | 型 | 説明 | 例 |
---|---|---|---|
result | 配列 | フォルダの一覧です。 | - |
+ folderId | 数値 | フォルダID | 10001 |
+ folderName | 文字列 | フォルダ名 | Folder 1 |
+ type | 文字列 | フォルダの種類
| normal |
+ created | 日付 | 作成日(RFC2822) | Mon, 10 Aug 2009 17:00:00 +0900 |
+ updated | 日付 | 更新日(RFC2822) | Mon, 10 Aug 2009 17:00:00 +0900 |
JSON形式のレスポンスの例
{
"result": [
{
"folderId": 10001,
"folderName": "Folder 1",
"type": "normal",
"created": "Mon, 10 Aug 2009 17:00:00 +0900",
"updated": "Mon, 10 Aug 2009 17:00:00 +0900"
},
{
// ...
}
]
}
XML形式のレスポンスの例
<?xml version="1.0" encoding="utf-8"?>
<folders>
<result>
<folder>
<folderId>10001</folderId>
<folderName>Folder 1</folderName>
<type>normal</type>
<created>Mon, 10 Aug 2009 17:00:00 +0900</created>
<updated>Mon, 10 Aug 2009 17:00:00 +0900</updated>
</folder>
<folder>
...
</folder>
</result>
</folders>