API Guide > Getting Started > List the Structure and Contents of the Workspace
|
Developer Forum - Ask the LiquidPlanner development team questions. Note that the LP iPhone app uses this same API. |
|
API Sample Code – See the API in action then give it a try. |
Enter a search term or try the Dev Forums for more answers.
LiquidPlanner uses a RESTful web service API. You can download the API Guide (PDF) for offline reference. Most actions that you can perform within the application can be automated using the API -- for example, you can create a task, comment on the task, track time against it, and then mark it done.
NEED HELP? Please post API questions in the API forums
The contents of a workspace are organized in a tree. Every workspace has a root. The root may be empty (in which case you have a empty workspace), or it may contain projects and packages. In turn, these projects and packages may contain other items.
To fetch only the root, request treeitems with a depth of 0:
% curl https://app.liquidplanner.com/api/workspaces/:id/treeitems?depth=0
... wall of text ...If you want the entire tree, you do:
% curl https://app.liquidplanner.com/api/workspaces/:id/treeitems?depth=-1&leaves=true
... larger wall of text ...See The Workspace Tree for details.
