folders

List Project Folders

Retrieve the top level of a project's Docs tab: workflow phases, plus any real doc folders that sit at the project root (not nested in another folder or scoped to a phase).

Each item carries a type field (phase or folder) telling you what it is and, for folders, matches the shape of GET /folders/{folder_id}.

Behavior change: this endpoint used to return every real folder flat, including ones nested under another folder or scoped to a phase. It now returns root-level folders only, alongside phase rows, matching what the UI shows at the top of the Docs tab. To see what's inside a phase or folder, use GET /phases/{phase_instance_id}/contents or GET /folders/{folder_id}/contents.

Pagination (page/page_size) applies only to the folder half of the results — phase rows are returned unpaginated (bounded by the project's workflow, not user-created volume). Pass include_archived=true to include archived root folders (default false); this doesn't affect phase rows.

get/projects/{project_id}/folders

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/projects/{project_id}/folders
  • Auth: API key in header x-api-key

Path parameters

project_idinteger required

Project identifier

Query parameters

include_archivedboolean

Whether to include archived (inactive) records in the response. By default only active records are returned.

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page (max 100)

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.