1. Home
  2. Docs
  3. Advanced Topics
  4. API Methods
  5. Folder API methods

Folder API methods

Standard Parameters for all methods

account={account}&dataConnect={dataConnect}&clientId={clientId}&userId={userId}&userRole={userRole} 

Methods

GET /GetFolders 
Query Parameters (in addition to standard parameters)
None

Success Response
Get a List of Folders

Example Response
[
   {
     "FolderName": "Customer Reports",
     "ClientId": "",
     "UserId": "",
     "Id": 20,
   },
   {
     "FolderName": "Default Folder",
     "ClientId": "",
     "UserId": "",
     "Id": 0
   }
 ]
 
POST /SaveFolder
Query Parameters (in addition to standard parameters)
folderId    - id of folder to update, 0 to create new
folderName  - name of folder to update/create

Success Response
Get the saved folder id

Example Response
5 
POST /DeleteFolder
Query Parameters (in addition to standard parameters)
folderId    - id of folder to delete

Success Response
Get true if successful

Example Response
{success: true} 
Was this article helpful to you? Yes No

How can we help?

Leave a Reply

Your email address will not be published. Required fields are marked *