Sign in

v1

latestOpenAPI 3.1.02026-07-2671117149.2 KB
Apis
Folders

List Folders

get/folders

Query parameters

limitinteger nullable

Control the maximum number of folder items returned in a single API response to optimize performance and manage data consumption. Set this value between 1 and 100 based on your application's needs - use smaller limits for faster initial loading and pagination scenarios, or larger limits when you need comprehensive folder overviews. This parameter helps balance API response speed with data completeness, ensuring your workspace queries remain responsive even with extensive folder collections.

search_querystring nullable

Filter folders by entering partial or complete folder names to quickly locate specific organizational containers within your CAMB.AI workspace. The search functionality matches against folder names using case-insensitive partial matching, allowing you to find folders like 'Marketing Projects' by searching for terms like 'market' or 'proj'. This targeted filtering becomes invaluable as your workspace grows, enabling rapid navigation to relevant project folders without scrolling through extensive folder lists.

Response

Successful Response

team_idinteger

Unique identifier for the team that owns this folder within the CAMB.AI workspace. This establishes the organizational hierarchy and ensures that folder access permissions align with your team's collaboration settings, allowing team members to share and manage projects collectively while maintaining proper access control.

folder_idinteger

Unique system identifier for this specific folder within your CAMB.AI workspace. This ID serves as the primary reference when creating new tasks, organizing existing projects, or performing folder-related operations through the API, ensuring precise folder targeting across all workspace interactions.

folder_namestring

Display name for the folder as it appears in your CAMB.AI workspace dashboard. Choose meaningful names that reflect the folder's purpose or project category, such as 'Marketing Audio Projects' or 'Podcast Transcriptions', to help you and your team quickly identify and navigate to the right organizational container for your tasks.

run_countinteger

Total number of completed tasks and processing runs currently stored within this folder. This metric provides valuable insight into folder activity levels and helps you monitor project volume, making it easier to assess workspace utilization and identify your most active project categories for better resource planning and organization.