v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Folders

List folders

Retrieve all folders in your workspace. Folders are used to organize projects, docs, channels, dashboards, agents, and other folders into a hierarchical structure — similar to a file system.

Results can be filtered by title or parent folder, sorted by creation date or title, and are paginated.

Tip: To list only root-level folders, filter with filter[parent_folder_id]=null. To list children of a specific folder, set filter[parent_folder_id] to that folder's ID.

Note: The folders field (containing child folder IDs) is only populated when filtering by parent_folder_id. Without this filter, folders will be null for performance reasons. To retrieve child folders for a specific folder, either use filter[parent_folder_id] or call the Get folder (GET /v1/folders/:folder_id) endpoint.

get/v1/folders

Query parameters

start_cursorstring
limitinteger nullable

See Pagination for details about how to use a cursor to iterate through the list.

parent_folder_idstring nullable

Filter by parent folder ID. Pass null to get root-level folders.

See Filters for details on parameter formatting.

'created_at:asc' | 'created_at:desc' | 'title:asc' | 'title:desc'
OR
string[]

See Sort for details on the sort parameter.

Response

200