Folders

Query Folders

Changed on

Filter folders inside the caller's project.

Follows the general response envelope described in the Query Pattern guide, but does not accept windowing or include_archived — folders are hard-deleted and the response always returns the full filtered set. Filters include id/ids, slug/slugs, kind/kinds, parent_id/parent_ids (use parent_id: null for root folders), path/paths, and prefix/prefixes for subtree lookup.

post/folders/query

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/query
  • Auth
    API key in header Authorization

Request body

Response

Successful Response

countinteger

Number of folders in folders.

Changes

  • a7f9a6823230Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • d7e21f629c88Revision changes
    • info

      the response's property default value was removed for the status