---
title: "Get count of all folders, messages and message_ids not in folders grouped by workspace"
method: GET
path: "/folders/count-by-workspace"
tags: ["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
- `workspace_id` string

## Response `200`

- ListCountFoldersGroupedByWorkspace[]
  - `workspace_id` string, required
  - `total_folders` number, required
  - `total_messages` number, required
  - `message_ids_without_folder` string[]: List of Messages without Folder
  - `root_folders` Folder[]: List of Root Folders
    - `id` string, required: Unique Identifier
    - `name` string, required: Name
    - `creator_id` string, required: Creator
    - `parent_folder_id` string: Parent Folder ID
    - `subfolder_ids` string[]: List of Subfolder IDs
    - `message_ids` string[]: List of Message IDs
    - `path` string[]: Ordered List of all folders in the path from root to this folder
    - `total_nested_folders_count` number, required: Total count for all Nested Folders
    - `total_nested_messages_count` number, required: Total count for all Nested Messages
    - `type` 'voicememo' | 'prerecorded', required: Folder type
    - `workspace_id` string, required: Workspace ID where folder belongs to
    - `created_at` string, date-time, required
    - `last_updated_at` string, date-time, required
    - `deleted_at` string, date-time
    - `subfolders` SubFolder[]: Subfolders (only one deep level)
      - `id` string, required: Unique Identifier
      - `name` string, required: Name
      - `creator_id` string, required: Creator
      - `parent_folder_id` string: Parent Folder ID
      - `subfolder_ids` string[]: List of Subfolder IDs
      - `message_ids` string[]: List of Message IDs
      - `path` string[]: Ordered List of all folders in the path from root to this folder
      - `total_nested_folders_count` number, required: Total count for all Nested Folders
      - `total_nested_messages_count` number, required: Total count for all Nested Messages
      - `type` 'voicememo' | 'prerecorded', required: Folder type
      - `workspace_id` string, required: Workspace ID where folder belongs to
      - `created_at` string, date-time, required
      - `last_updated_at` string, date-time, required
      - `deleted_at` string, date-time
  - `last_updated_at` string, date-time, required

## Other responses

- `403`

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)