Users can create folders in their workspaces to help organize their boards, dashboards, and workdocs.

Queries

Get folders

• Required scope:workspaces:read
• Returns an array containing metadata about one or a collection of folders
• Can only be queried directly at the root; can't be nested within another query

query {
  folders(workspace_ids: [1234567890]) {
    id
    name
    children {
      id
      name
    }
  }
}

Arguments

Fields

Mutations

Required scope:workspaces:write

Create folder

Creates a new folder in a workspace. Returns Folder.

mutation {
  create_folder(
    name: "New folder", 
    workspace_id: 1234567890
	) {
    id
  }
}

Arguments

Update folder

Updates a folder's color, name, or parent folder. Returns Folder.

mutation {
  update_folder(
    folder_id: 1234567890,
    name: "Updated folder name",
    account_product_id: 54321,
    position: {
      object_id: "15",
      object_type: Board,
      is_after: false
    }
  ) {
    id
    name
  }
}

Arguments

Delete folder

Deletes a folder and all its contents. Returns Folder.

mutation {
  delete_folder(
    folder_id: 1234567890
	) {
    id
  }
}

Arguments