Folders

Get count of all folders, messages and message_ids not in folders grouped by workspace

get/folders/count-by-workspace

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/folders/count-by-workspace
  • 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

workspace_idstring

Workspace ID

Response

workspace_idstring required
total_foldersnumber required
total_messagesnumber required
message_ids_without_folderstring[]

List of Messages without Folder

last_updated_atstring date-time required

Example response

[
  {
    "root_folders": [
      {
        "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.