API ReferenceFolders

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.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

opportunity_idintegerRequired
Opportunity identifier

Query parameters

include_archivedbooleanOptionalDefaults to false

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

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

Successful response
phaseobject

A virtual “folder” row synthesized from a workflow phase — not a real Folder database record. Use its id as phase_instance_id on GET /phases/{phase_instance_id}/contents.

OR
folderobject

A real doc folder, as returned by GET /projects/{project_id}/folders.

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error