Folders
List folders
Returns a workspace's top-level folders, each with its subfolders.
Needs a token with viewCostReports on the workspace.
query Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredpageThe page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.
limitItems per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.
List folders › Responses
Success
Create folder
Creates a new folder for organizing reports.
Needs a token with createFolder on the workspace.
Headers
Idempotency-KeyA unique value, at most 255 printable ASCII characters, such as a UUID, that makes retrying this create safe. A retry with the same key and the same request within 24 hours answers the first response again, marked Idempotent-Replayed: true, and creates nothing; the same key with another request answers 422 idempotency_key_reused. A key is kept only for a create that succeeded. Without it, every request creates.
Create folder › Request Body
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredtitleCreate folder › Responses
Created
id^fld_[A-Za-z0-9_-]{2… · requiredtitleGet folder
Returns a specific folder.
Needs a token with viewCostReports on the workspace.
path Parameters
folderId^fld_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredGet folder › Responses
Success
id^fld_[A-Za-z0-9_-]{2… · requiredtitlereportCountchildrenFolderResponse (circular)Update folder
Updates a folder's title or parent in place; a field left out keeps its value, and clearParent moves the folder to the top of the tree.
Needs a token with updateFolder on the workspace.
path Parameters
folderId^fld_[A-Za-z0-9_-]{2… · requiredHeaders
If-MatchApplies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.
Update folder › Request Body
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredtitleclearParentUpdate folder › Responses
Success
id^fld_[A-Za-z0-9_-]{2… · requiredtitlereportCountchildrenFolderResponse (circular)Delete folder
Deletes a folder. Its reports and subfolders move to its parent folder, or to the top level when it has none.
Needs a token with deleteFolder on the workspace.
path Parameters
folderId^fld_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredHeaders
If-MatchApplies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.
Delete folder › Responses
No Content
Set folder saved filter
Attaches a saved filter of the same workspace to the folder, so every cost report in it and in its subfolders is read through that filter on top of its own. A null savedFilterId detaches the one attached.
Needs a token with updateFolder on the workspace.
path Parameters
folderId^fld_[A-Za-z0-9_-]{2… · requiredHeaders
If-MatchApplies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.
Set folder saved filter › Request Body
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredSet folder saved filter › Responses
Success
id^fld_[A-Za-z0-9_-]{2… · requiredtitlereportCountchildrenFolderResponse (circular)