​

space folders

orc space folders lists, creates, updates, and archives folders in the Space folder tree. These are the same folders shown in the sidebar folder tree.

Authentication and a selected Workspace are required. Creating, updating, and archiving folders and moving files or folders require files:write. Moving documents and sheets requires doc:update instead.

List the folders in a Workspace.

Returns every folder that is not archived. With --project-id, returns only folders whose nearest explicit project matches. Archived ancestors still supply the project.

value

Type: string. Optional.

Creates a folder with a title. Set the parent folder with parent_id, the project with project_id, and the display with color and position. Omitted values default to no parent, no project, no color, and position 0.

Body field: color; (use "null" or "reset" to clear); max 128 chars

Type: string. Optional.

Body field: parent_id; (use "null" or "reset" to clear)

Type: string. Optional.

Body field: position

Type: number. Optional.

Body field: project_id; (use "null" or "reset" to clear)

Type: string. Optional.

(required) Body field: title; max 256 chars

Type: string. Optional.

Changes a folder's title, color, position, or project. Changing parent_id moves the folder under another folder, and null moves it to the top level. Parent folders and projects must belong to the same Workspace, and moving a folder into itself or a descendant returns 400.

Body field: color; (use "null" or "reset" to clear); max 128 chars

Type: string. Optional.

Body field: parent_id; (use "null" or "reset" to clear)

Type: string. Optional.

Body field: position

Type: number. Optional.

Body field: project_id; (use "null" or "reset" to clear)

Type: string. Optional.

Body field: title; max 256 chars

Type: string. Optional.

Archives the folder with the given ID.

Moves a document, sheet, file, or folder into a folder. kind is document, sheet, file, or folder. Passing null as folder_id removes the item from its folder. Moving a folder runs the same cycle checks as folders update.

(required) Body field: folder_id; (use "null" or "reset" to clear)

Type: string. Optional.

The following global options can be used with orc space folders:

For details and examples, see global options.