Skip to main content

getCompanyFoldersList

This method returns the list of company folders under a company or under a company folder.

Parameters

Parameter

Type

Optional

Description

parentId

String

Yes

The parent company's ID or the parent folder's ID. The default value is the ID of the parent company.

Return value

This method returns an Array containing the list of folders located under the parent company. Each entry in the list has the following fields:

  • id - the ID of the folder

  • name - the name of the folder

Example

Request:

  {
       "params": {
           "parentId" : "54a295d8b1a43d7c4a7b23c6"
       },
       "jsonrpc": "2.0",
       "method": "getCompanyFoldersList",
       "id": "8edf135b-f7cb-41f2-8b67-98054694f61e"
  }

Response:

  {
      "id":"8edf135b-f7cb-41f2-8b67-98054694f61e",
      "jsonrpc":"2.0",
      "result": [
              {
                  "id" : "54a29726b1a43d8a497b23c6",
                  "name" : "Company folder 1"
              },
              {
                  "id" : "54a29746b1a43d0f4c7b23c6",
                  "name" : "Company folder 2"
              }
          ]
  }