Folders

Get Folder by ID

get/folders/{id}

Request

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

Path parameters

idstring required

Query parameters

include_first_level_treeboolean

Defines if the first level of the folder tree should be returned

direction'older' | 'newer'

Direction of the results (newer or older)

datestring date-time nullable

Return only Subfolders updated based on the date and direction (must inform include_first_level_tree = true)

Response

idstring required

Unique Identifier

namestring required

Name

creator_idstring required

Creator

parent_folder_idstring

Parent Folder ID

subfolder_idsstring[]

List of Subfolder IDs

message_idsstring[]

List of Message IDs

pathstring[]

Ordered List of all folders in the path from root to this folder

total_nested_folders_countnumber required

Total count for all Nested Folders

total_nested_messages_countnumber required

Total count for all Nested Messages

type'voicememo' | 'prerecorded' required

Folder type

workspace_idstring required

Workspace ID where folder belongs to

created_atstring date-time required
last_updated_atstring date-time required
deleted_atstring date-time

Example response

{
  "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.