Hello World Example Request

🚧

Please read about Data Formats, Authentication, and Authorization

This page assumes you have read and understood the content in our Authentication and Authorization page. It also assumes you have created a .liquidplanner_curl configuration file as described in our Data Formats page.

Let’s start with a simple “Hello, World!” request that fetches your LiquidPlanner account details. Tell curl to read from the configuration file you just created, and request your account info:

% curl -K ~/.liquidplanner_curl https://app.liquidplanner.com/api/v1/account

Example Results:

{
  "avatar_url": "/images/avatars/none.png",
  "created_at": "1977-09-10T00:00:01+00:00"
  "created_by": 23,
  "email":      "[email protected]",
  "first_name": "Brett",
  "id":         23,
  "last_name":  "Bender",
  "timezone":   "US/Pacific",
  "type":       "Member",
  "updated_at": "2010-01-01T00:00:01+00:00",
  "updated_by": 23,
  "user_name":  "brett",
}
Status: 200

For brevity in subsequent examples, we write curl where we really mean:

curl -K ~/.liquidplanner_curl

so that your configuration file is used. You may want to create a command alias such as lpcurl for the above as it will save you some typing.