Folders

Returns information about your folders.

Method

GET

URL

https://cacoo.com/api/v1/folders.format
Example : https://cacoo.com/api/v1/folders.json

Format

json, xml

Authentication

required

Parameters

Parameter Name	Type	Content	Example
organizationKey(Required)	String	Organization Key from the Organizations API	abcdefghij

*If you are using a legacy plan (i.e. the old Free Plan or Plus Plan), you do not need to add organizationKey to the parameters.

Response

Field	Type	Description	Example
result	Array	Folder array	-
+ folderId	Integer	Folder ID	10001
+ folderName	String	Folder name	Folder 1
+ type	String	Folder type normal - Normal folder shared - Shared folder	normal
+ created	Date	Date Created(RFC2822)	Mon, 10 Aug 2009 17:00:00 +0900
+ updated	Date	Date last updated(RFC2822)	Mon, 10 Aug 2009 17:00:00 +0900

JSON Response Example

{
    "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 Response Example

<?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>