Skip to navigation

Get Folder Contents

List a folder’s direct children: subfolders, files, and forms filed directly in it (not further nested).

Each item carries a type field (folder, file, or form) telling you what it is. For type: "folder" items, call this same endpoint again with that folder’s id to walk further in. Forms are ordinary files under the hood (isForm: true on the underlying file) that inherit their folder/phase placement, so they appear here rather than in a separate forms listing.

Note: on this endpoint (and the phase-contents endpoint), the file’s MIME/category label is named fileType instead of type, to avoid colliding with the folder/file/form discriminator. This does not affect GET /projects/{project_id}/files, where type keeps its original meaning.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

folder_idintegerRequired
Folder identifier

Query parameters

include_archivedbooleanOptionalDefaults to false

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

Response

Successful response
folderobject

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

OR
fileobject

A file (or form — see type) inside a folder or phase’s direct contents.

OR
formobject

A file (or form — see type) inside a folder or phase’s direct contents.

Errors

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