Folders

Get all root Folders

get/folders

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/folders
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

type'voicememo' | 'prerecorded' required

Folder Type

include_all_treeboolean

Return all folders tree

workspace_idstring

Workspace ID

sort_direction'ASC' | 'DESC'

Sort order direction

sort_by'created_at' | 'last_updated_at' | 'name'

Field to sort by

Response

type'voicememo' | 'prerecorded' required

Folder Type

include_all_treeboolean

Return all folders tree

workspace_idstring

Workspace ID

sort_direction'ASC' | 'DESC'

Sort order direction

sort_by'created_at' | 'last_updated_at' | 'name'

Example response

{
  "results": [
    {
      "path": [
        "Parent Folder ID",
        "Parent Parent Folder ID",
        "Root Folder ID"
      ],
      "subfolders": [
        {
          "path": [
            "Parent Folder ID",
            "Parent Parent Folder ID",
            "Root Folder ID"
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.