folders

List Opportunity Folders

Retrieve the top level of an opportunity's Docs tab: workflow phases, plus any real doc folders that sit at the opportunity root (not nested in another folder or scoped to a phase). Same shape as the project version of this endpoint — opportunities have their own workflow phases too.

To see what's inside a phase or folder, use GET /phases/{phase_instance_id}/contents or GET /folders/{folder_id}/contents — both are addressed by id alone, no opportunity needed in the path.

get/opportunities/{opportunity_id}/folders

Request

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

Path parameters

opportunity_idinteger required

Opportunity 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.