Sign-in
Top

LiquidPlanner
30-day free trial
30-second sign-up

API Guide > Technical Reference (14 entries)

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

  • Base URL
    All API requests are made relative to this base URL: https://app.liquidplanner.com/api The base URL may change (for example, it could move to a separate hostname dedicated ...
  • Authentication and Authorization
    Each API request is authenticated by HTTP Basic Authentication . Use the same credentials (email address and password) that you use to login to the LiquidPlanner web application. Incorrect ...
  • Types, Attributes, Data Model
    The available record types and their attributes may change over time; you can view a dynamically generated reference at https://app.liquidplanner.com/api/help/types
  • The Workspace Tree
    Items and Containers We use the term item or treeitem to refer to the things that you can arrange in your workspace tree – treeitems include Tasks, Events, ...
  • The Treeitems Resource
    There is a special resource for treeitems; you can use it to “blindly” show, update, or nest into any sort of item without knowing its type in advance (but not to ...
  • Including Associated Records
    Specify an ‘include’ parameter with a comma separated list of things to include. Valid things to include are: activities comments  ...
  • Request Throttling
    Each user account may make up to 30 requests per 15 seconds . We may tune this limit as needed to maintain overall system availability and responsiveness. If you ...
  • Filtering
    When requesting items such as folders, packages, or tasks you can filter or restrict the set of results returned to those matching the criteria you specify. There are two ...
  • Filtering Timesheet Entries
    You can filter timesheet entries according to criteria that you specify. This is conceptually similar to the filtering on items, but the syntax is simpler and designed to correspond to options ...
  • Ordering and Limiting of Results
    Order Param You can request that a list of tasks be returned in a particular order. Specify an order parameter whose value is one of the ...
  • API Versioning
    You may use the request header X-API-Version to specify your expected API version. The currently supported versions are: 0.9.0 1.0.0 If the version header is omitted, ...
  • Data Formats
    JSON Responses Responses to successful requests have a response body consisting of a JSON hash (for single records) or a JSON array of JSON hashes (for multiple records). ...
  • HTTP Status Codes
    Check the HTTP status code of responses from the API to determine whether your request was processed successfully. Success Codes 200 OK successful read, update, or ...
  • Error Responses
    Response Body When returning an error, the response body contains details of the error represented as a JSON hash. For example, requesting the invalid “/bad_url” results ...