Get folder list

This API method provides a list of folders under a given folder.

Request

GET       /api/1/folders/{folderid}/items

Parameters

 

Query Parameters

Request body

No request body is required for this call.

Response

API Version 1

<folders>

    <folder>

        <id>10603</id>

        <name>First</name>

        <permission>UPDATE</permission>            <!-- ( Permission Element in API version 1)  -->

        <child>1</child>

        <parentFolderID>210</parentFolderID>

        <accessInherited>1</accessInherited>            <!-- (supported from 4.0.2 branch)  -->

        <createddate>19 Aug 2016 07:04</createddate>

        <modifieddate>19 Aug 2016 07:04</modifieddate>

        <location>folder1/folder2</location>                <!-- (supported from 4.0.3 branch)  -->

        <createdby>

            <firstname>first</firstname>

            <lastname>last</lastname>

            <email>first.last@domain.com</email>

            <userid>368</userid>

        </createdby>

        <modifiedby>

            <firstname>first</firstname>

            <lastname>last</lastname>

            <email>first.last@domain.com</email>

            <userid>368</userid>

        </modifiedby>

    </folder>

</folders>

API Version 2 (Support from 4.0.3)

<folders>

    <folder>

        <id>10603</id>

        <name>First</name>

        <permission>

            <view>1</view>

            <edit>1</edit>

            <delete>1</delete>

            <addEditAllFiles>1</addEditAllFiles>            <!-- ( Permission Element in API version 2)  -->

            <viewAllFiles>1</viewAllFiles>

            <admin>1</admin>

        </permission>

        <child>1</child>

        <auto-numbering>2.1</auto-numbering> <!-- (Added in 4.1.3) -->

        <filecount>65</filecount>   <!-- ( file count tag has been added in 4.1.3 ) -->

        <parentFolderID>210</parentFolderID>

        <accessInherited>1</accessInherited>                <!-- (supported from 4.0.3 branch)  -->

        <createddate>19 Aug 2016 07:04</createddate>

        <modifieddate>19 Aug 2016 07:04</modifieddate>

        <location>folder1/folder2</location>                    <!-- (supported from 4.0.3 branch)  -->

        <createdby>

            <firstname>first</firstname>

            <lastname>last</lastname>

            <email>first.last@domain.com</email>

            <userid>368</userid>

        </createdby>

        <modifiedby>

            <firstname>first</firstname>

            <lastname>last</lastname>

            <email>first.last@domain.com</email>

            <userid>368</userid>

        </modifiedby>

    </folder>

</folders>

In case of an error the method returns an error object.

Notes

1. The value of limit parameter behaves as following 
   
   limit =100 is the default value
   
   if limit>0 then (number of items returned is equal to limit)
   
   if limit=-1 then return all records
   
   if limit <-1 then the system returns the default no of items i.e 100
2. The value of Offset parameter behaves as under
   
   (Default) offset =0 
   
   if offset > 0 then the records are returned from the offset value
   
   if offset < 0 then offset value of 0 is set
3. Default value for orderby parameter is asc
4. Default value if ordertype is creation date
5. The return elements of permissions and accessInherited was added in version 4.0.3 of the API and are explained in the Get Folder Info API 
6. The location element has been added in Collaborate 4.0.3 and provides the folder hierarchy of the specific folder on the site. 

Error codes