LiquidPlanner

The LiquidPlanner Developer Hub

Welcome to the LiquidPlanner developer hub. You'll find comprehensive guides and documentation to help you start working with LiquidPlanner as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
Suggest Edits

About Treeitems

 

For more information on Treeitems, see our help article on the Treeitem Data Model.

Suggest Edits

clients/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

workinteger

sum of the work tracked against items contained by this client

alertsstring

array of zero or more alerts

created_atstring
created_byinteger
done_onstring

timestamp specified by user (or defaulted to "now") when the client is marked done

started_onstring

the date on which work first started for the client

descriptionstring

plain-text description of the client

earliest_finishstring

timestamp for 10% probable finish of all tasks in the client

earliest_startstring

timestamp for 10% probable start of some task in the client

expected_finishstring

timestamp for 50% probable finish of all tasks in the client

expected_startstring

timestamp for 50% probable start of some task in the client

p98_finishstring

timestamp for 98% probable finish of latest task in the client

has_noteboolean

true if there is a note for this client

high_effort_remaininginteger

high (worst case) estimate of remaining effort to complete client

is_doneboolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

is_on_holdboolean

boolean, if set to true, all tasks in the client are not scheduled

effective_is_on_holdstring

boolean, if set to true, all tasks in the client are not scheduled

latest_finishstring

timestamp for 90% probable finish of all tasks in the client

low_effort_remaininginteger

low (best case) estimate of remaining effort to complete all tasks for this client

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

namestring

name of this client

assignmentsstring
contract_valuestring
external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
billable_expensesstring

The total of all billable lineitem expenses associated with this client.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this client.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this client.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

client
object
 
client.done_on
string

timestamp specified by user (or defaulted to "now") when the client is marked done

client.description
string

plain-text description of the client

client.is_done
boolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

client.is_on_hold
boolean

boolean, if set to true, all tasks in the client are not scheduled

client.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

client.name
string

name of this client

client.assignments
string
client.contract_value
string
client.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against items contained by this client

alertsstring

array of zero or more alerts

created_atstring
created_byinteger
done_onstring

timestamp specified by user (or defaulted to "now") when the client is marked done

started_onstring

the date on which work first started for the client

descriptionstring

plain-text description of the client

earliest_finishstring

timestamp for 10% probable finish of all tasks in the client

earliest_startstring

timestamp for 10% probable start of some task in the client

expected_finishstring

timestamp for 50% probable finish of all tasks in the client

expected_startstring

timestamp for 50% probable start of some task in the client

p98_finishstring

timestamp for 98% probable finish of latest task in the client

has_noteboolean

true if there is a note for this client

high_effort_remaininginteger

high (worst case) estimate of remaining effort to complete client

is_doneboolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

is_on_holdboolean

boolean, if set to true, all tasks in the client are not scheduled

effective_is_on_holdstring

boolean, if set to true, all tasks in the client are not scheduled

latest_finishstring

timestamp for 90% probable finish of all tasks in the client

low_effort_remaininginteger

low (best case) estimate of remaining effort to complete all tasks for this client

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

namestring

name of this client

assignmentsstring
contract_valuestring
external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
billable_expensesstring

The total of all billable lineitem expenses associated with this client.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this client.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this client.

Suggest Edits

clients/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against items contained by this client

alertsstring

array of zero or more alerts

created_atstring
created_byinteger
done_onstring

timestamp specified by user (or defaulted to "now") when the client is marked done

started_onstring

the date on which work first started for the client

descriptionstring

plain-text description of the client

earliest_finishstring

timestamp for 10% probable finish of all tasks in the client

earliest_startstring

timestamp for 10% probable start of some task in the client

expected_finishstring

timestamp for 50% probable finish of all tasks in the client

expected_startstring

timestamp for 50% probable start of some task in the client

p98_finishstring

timestamp for 98% probable finish of latest task in the client

has_noteboolean

true if there is a note for this client

high_effort_remaininginteger

high (worst case) estimate of remaining effort to complete client

is_doneboolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

is_on_holdboolean

boolean, if set to true, all tasks in the client are not scheduled

effective_is_on_holdstring

boolean, if set to true, all tasks in the client are not scheduled

latest_finishstring

timestamp for 90% probable finish of all tasks in the client

low_effort_remaininginteger

low (best case) estimate of remaining effort to complete all tasks for this client

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

namestring

name of this client

assignmentsstring
contract_valuestring
external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
billable_expensesstring

The total of all billable lineitem expenses associated with this client.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this client.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this client.

Suggest Edits

clients/:id

 

Header Auth

 Authentication is required for this endpoint.
puthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
curl --request PUT \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

client
object
 
client.done_on
string

timestamp specified by user (or defaulted to "now") when the client is marked done

client.description
string

plain-text description of the client

client.is_done
boolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

client.is_on_hold
boolean

boolean, if set to true, all tasks in the client are not scheduled

client.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

client.name
string

name of this client

client.assignments
string
client.contract_value
string
client.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against items contained by this client

alertsstring

array of zero or more alerts

created_atstring
created_byinteger
done_onstring

timestamp specified by user (or defaulted to "now") when the client is marked done

started_onstring

the date on which work first started for the client

descriptionstring

plain-text description of the client

earliest_finishstring

timestamp for 10% probable finish of all tasks in the client

earliest_startstring

timestamp for 10% probable start of some task in the client

expected_finishstring

timestamp for 50% probable finish of all tasks in the client

expected_startstring

timestamp for 50% probable start of some task in the client

p98_finishstring

timestamp for 98% probable finish of latest task in the client

has_noteboolean

true if there is a note for this client

high_effort_remaininginteger

high (worst case) estimate of remaining effort to complete client

is_doneboolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

is_on_holdboolean

boolean, if set to true, all tasks in the client are not scheduled

effective_is_on_holdstring

boolean, if set to true, all tasks in the client are not scheduled

latest_finishstring

timestamp for 90% probable finish of all tasks in the client

low_effort_remaininginteger

low (best case) estimate of remaining effort to complete all tasks for this client

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

namestring

name of this client

assignmentsstring
contract_valuestring
external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
billable_expensesstring

The total of all billable lineitem expenses associated with this client.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this client.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this client.

Suggest Edits

clients/:id

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
curl --request DELETE \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/clients/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against items contained by this client

alertsstring

array of zero or more alerts

created_atstring
created_byinteger
done_onstring

timestamp specified by user (or defaulted to "now") when the client is marked done

started_onstring

the date on which work first started for the client

descriptionstring

plain-text description of the client

earliest_finishstring

timestamp for 10% probable finish of all tasks in the client

earliest_startstring

timestamp for 10% probable start of some task in the client

expected_finishstring

timestamp for 50% probable finish of all tasks in the client

expected_startstring

timestamp for 50% probable start of some task in the client

p98_finishstring

timestamp for 98% probable finish of latest task in the client

has_noteboolean

true if there is a note for this client

high_effort_remaininginteger

high (worst case) estimate of remaining effort to complete client

is_doneboolean

boolean, if set to true, all tasks in the client are done and therefore not scheduled

is_on_holdboolean

boolean, if set to true, all tasks in the client are not scheduled

effective_is_on_holdstring

boolean, if set to true, all tasks in the client are not scheduled

latest_finishstring

timestamp for 90% probable finish of all tasks in the client

low_effort_remaininginteger

low (best case) estimate of remaining effort to complete all tasks for this client

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

namestring

name of this client

assignmentsstring
contract_valuestring
external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
billable_expensesstring

The total of all billable lineitem expenses associated with this client.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this client.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this client.

Suggest Edits

events/:id/track_time

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/track_time"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

work

hours worked; optional

activity_id

id of the activity for the work; required if you are using timesheets and provide a value for work

member_id

member_id against whom to track the work; optional, defaults to the current user

low

low estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide high, omit or set to '0' when setting is_done

high

high estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide low, omit or set to '0' when setting is_done

is_done

if true, marks task as done, low and high must each be zero; if false or omitted, sets task to not done (if it is done, otherwise no effect)

done_on

datetime on which the task was done; valid only when is_done=true, defaults to now

work_performed_on

date on which the work was performed, default today. Must be in ISO-8601 format.

comment

comment to add to the task, optional

Response

OK

Suggest Edits

events/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

Suggest Edits

events/:id/move_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move before the packaged version of the treeitem.

Response

OK

Suggest Edits

events/:id/move_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/move_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move after the packaged version of the treeitem.

Response

OK

Suggest Edits

events/:id/package_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged before.

Response

OK

Suggest Edits

events/:id/package_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/package_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged after.

Response

OK

Suggest Edits

events/:id/activities

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id/activities"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

event
object
 
event.activity_id
integer

ID of the activity most recently used for tracking time against this item, suggested for use as a default

event.custom_field_values
string

hash of custom fields and their assigned values for this item

event.start_date
string

the date on which this event starts

event.description
string

plaintext summary of this item

event.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

event.is_on_hold
boolean

if true, then the event is on hold, and will not be scheduled

event.is_shared
boolean

if true, then the event may be visible on a project portal

event.manual_alert
string

editable, arbitrary string; if nonblank, generates an alert on this item

event.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

event.name
string

name of this event

event.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

event.parent_id
integer

ID of the parent project/folder/package

event.finish_date
string

the date on which this event ends

event.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

event.package_id
integer

ID of the package the event belongs to, if any

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

events/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

events/:id

 

Header Auth

 Authentication is required for this endpoint.
puthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
curl --request PUT \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

event
object
 
event.activity_id
integer

ID of the activity most recently used for tracking time against this item, suggested for use as a default

event.custom_field_values
string

hash of custom fields and their assigned values for this item

event.start_date
string

the date on which this event starts

event.description
string

plaintext summary of this item

event.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

event.is_on_hold
boolean

if true, then the event is on hold, and will not be scheduled

event.is_shared
boolean

if true, then the event may be visible on a project portal

event.manual_alert
string

editable, arbitrary string; if nonblank, generates an alert on this item

event.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

event.name
string

name of this event

event.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

event.parent_id
integer

ID of the parent project/folder/package

event.finish_date
string

the date on which this event ends

event.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

event.package_id
integer

ID of the package the event belongs to, if any

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

events/:id

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
curl --request DELETE \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/events/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_datestring

the date on which this event starts

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to finish_date

earliest_startstring

identical to start_date

expected_finishstring

identical to finish_date

expected_startstring

identical to start_date

p98_finishstring

identical to finish_date

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to finish_date

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

finish_datestring

the date on which this event ends

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

folders/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

Suggest Edits

folders/:id/move_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move before the packaged version of the treeitem.

Response

OK

Suggest Edits

folders/:id/move_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id/move_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move after the packaged version of the treeitem.

Response

OK

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this item

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the high_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

folder
object
 
folder.done_on
string

the date on which this item was completed, defaulted to today if the item is marked done today

folder.delay_until
string

a date before which no item in this container will start

folder.description
string

plaintext description of this item

folder.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

folder.is_on_hold
boolean

if true, then the item is on hold, and will not be scheduled

folder.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

folder.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

folder.name
string

name of this item

folder.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

folder.parent_id
integer
folder.promise_by
string

if the expected_finish of the item falls after this date, an alert is generated

folder.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this item

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the high_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

folders/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this item

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the high_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

folders/:id

 

Header Auth

 Authentication is required for this endpoint.
puthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
curl --request PUT \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

folder
object
 
folder.done_on
string

the date on which this item was completed, defaulted to today if the item is marked done today

folder.delay_until
string

a date before which no item in this container will start

folder.description
string

plaintext description of this item

folder.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

folder.is_on_hold
boolean

if true, then the item is on hold, and will not be scheduled

folder.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

folder.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

folder.name
string

name of this item

folder.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

folder.parent_id
integer
folder.promise_by
string

if the expected_finish of the item falls after this date, an alert is generated

folder.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this item

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the high_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

folders/:id

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
curl --request DELETE \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/folders/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this item

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the high_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

Milestone

 
Suggest Edits

milestones/:id/track_time

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/track_time"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

work

hours worked; optional

activity_id

id of the activity for the work; required if you are using timesheets and provide a value for work

member_id

member_id against whom to track the work; optional, defaults to the current user

low

low estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide high, omit or set to '0' when setting is_done

high

high estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide low, omit or set to '0' when setting is_done

is_done

if true, marks task as done, low and high must each be zero; if false or omitted, sets task to not done (if it is done, otherwise no effect)

done_on

datetime on which the task was done; valid only when is_done=true, defaults to now

work_performed_on

date on which the work was performed, default today. Must be in ISO-8601 format.

comment

comment to add to the task, optional

Response

OK

Suggest Edits

milestones/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

Suggest Edits

milestones/:id/move_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move before the packaged version of the treeitem.

Response

OK

Suggest Edits

milestones/:id/move_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/move_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move after the packaged version of the treeitem.

Response

OK

Suggest Edits

milestones/:id/package_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged before.

Response

OK

Suggest Edits

milestones/:id/package_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/package_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged after.

Response

OK

Suggest Edits

milestones/:id/activities

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id/activities"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

milestones

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

milestones

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

milestone
object
 
milestone.activity_id
integer

ID of the activity most recently used for tracking time against this item, suggested for use as a default

milestone.custom_field_values
string

hash of custom fields and their assigned values for this item

milestone.description
string
milestone.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

milestone.is_on_hold
boolean
milestone.is_shared
boolean
milestone.manual_alert
string
milestone.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

milestone.name
string
milestone.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

milestone.parent_id
integer

ID of the parent project/folder/package

milestone.date
string

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

milestone.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

milestone.package_id
integer

ID of the package the milestone belongs to, if any

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

milestones/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

milestones/:id

 

Header Auth

 Authentication is required for this endpoint.
puthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
curl --request PUT \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

milestone
object
 
milestone.activity_id
integer

ID of the activity most recently used for tracking time against this item, suggested for use as a default

milestone.custom_field_values
string

hash of custom fields and their assigned values for this item

milestone.description
string
milestone.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

milestone.is_on_hold
boolean
milestone.is_shared
boolean
milestone.manual_alert
string
milestone.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

milestone.name
string
milestone.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

milestone.parent_id
integer

ID of the parent project/folder/package

milestone.date
string

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

milestone.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

milestone.package_id
integer

ID of the package the milestone belongs to, if any

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

milestones/:id

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
curl --request DELETE \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/milestones/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

descriptionstring
earliest_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

earliest_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

expected_startstring

defined as 23:59:59 of the milestone date, local to the milestone owner

p98_finishstring

defined as 23:59:59 of the milestone date, local to the milestone owner

global_priorityinteger

overall order within the folder tree ("organize")

global_package_priorityinteger

overall order within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

defined as 0

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean
effective_is_on_holdstring
is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean
latest_finishstring
low_effort_remaininginteger

defined as 0

manual_alertstring
max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring
assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger

ID of the parent project/folder/package

datestring

the target or promise date for this milestone; an alert is generated if the milestone is not done and this date is in the past, or if the milestone depends on an item whose expected_finish is later than this date

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the milestone belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

 
Suggest Edits

packages/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

Suggest Edits

packages/:id/move_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move before the packaged version of the treeitem.

Response

OK

Suggest Edits

packages/:id/move_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id/move_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move after the packaged version of the treeitem.

Response

OK

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this package

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the low_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

package
object
 
package.done_on
string

the date on which this item was completed, defaulted to today if the item is marked done today

package.delay_until
string

a date before which no item in this container will start

package.description
string

plaintext description of this package

package.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

package.is_on_hold
boolean

if true, then the item is on hold, and will not be scheduled

package.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

package.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

package.name
string

name of this item

package.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

package.parent_id
integer
package.promise_by
string

if the expected_finish of the item falls after this date, an alert is generated

package.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this package

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the low_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

packages/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this package

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the low_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

packages/:id

 

Header Auth

 Authentication is required for this endpoint.
puthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
curl --request PUT \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

package
object
 
package.done_on
string

the date on which this item was completed, defaulted to today if the item is marked done today

package.delay_until
string

a date before which no item in this container will start

package.description
string

plaintext description of this package

package.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

package.is_on_hold
boolean

if true, then the item is on hold, and will not be scheduled

package.manual_alert
string

arbitrary string; if nonblank, generates an alert on this item

package.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

package.name
string

name of this item

package.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

package.parent_id
integer
package.promise_by
string

if the expected_finish of the item falls after this date, an alert is generated

package.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this package

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the low_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

packages/:id

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
curl --request DELETE \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/packages/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

workinteger

sum of the work tracked against all items in this container

alertsstring

list of zero or more alerts for this item

created_atstring
created_byinteger
done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

delay_untilstring

a date before which no item in this container will start

parent_delay_untilstring

delay until inherited from parent container

descriptionstring

plaintext description of this package

earliest_finishstring

the date on which there is 10% probability all items in this container will be finished

earliest_startstring

derived from the earliest_start of the earliest item in the container

expected_finishstring

the date on which there is 50% probability all items in this container will be finished

expected_startstring

derived from the expected_start of the earliest item in the container

p98_finishstring

the date on which there is 98% probability all items in this container will be finished

global_priorityinteger

overall order within the folder tree ("organize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

sum of the high_effort for the items in this container

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the item is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the item is on hold, and will not be scheduled

latest_finishstring

the date on which there is 90% probability all items in this container will be finished

low_effort_remaininginteger

sum of the low_effort for the items in this container

manual_alertstring

arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

parent_idinteger
parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

promise_bystring

if the expected_finish of the item falls after this date, an alert is generated

parent_promise_bystring

promise date inherited from parent container

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

occurrencesstring

array of schedules for each occurrence of the item

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
Suggest Edits

PartialDayEvent

 
Suggest Edits

partial_day_events/:id/track_time

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/track_time"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

work

hours worked; optional

activity_id

id of the activity for the work; required if you are using timesheets and provide a value for work

member_id

member_id against whom to track the work; optional, defaults to the current user

low

low estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide high, omit or set to '0' when setting is_done

high

high estimate for remaining work, hours (or a string such as "4h", "0.5d"); optional, must be provided if you provide low, omit or set to '0' when setting is_done

is_done

if true, marks task as done, low and high must each be zero; if false or omitted, sets task to not done (if it is done, otherwise no effect)

done_on

datetime on which the task was done; valid only when is_done=true, defaults to now

work_performed_on

date on which the work was performed, default today. Must be in ISO-8601 format.

comment

comment to add to the task, optional

Response

OK

Suggest Edits

partial_day_events/:id/update_assignment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/update_assignment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

assignment_id

the id of the assignment to be updated, required

person_id

the id of the person to whom the assignment should be assigned. null to unassign. optional.

low_effort_remaining

the new low_effort for the relevant assginment, optional

high_effort_remaining

the new high_effort for the relevant assignment, optional

activity_id

the id of the activity which will be set on the assignment, optional

Response

OK

Suggest Edits

partial_day_events/:id/move_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move before the packaged version of the treeitem.

Response

OK

Suggest Edits

partial_day_events/:id/move_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/move_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem.

packaged_other_id

(Advanced) ID of the other treeitem. Set this field instead of other_id if you want to move after the packaged version of the treeitem.

Response

OK

Suggest Edits

partial_day_events/:id/package_before

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_before"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged before.

Response

OK

Suggest Edits

partial_day_events/:id/package_after

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/package_after"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Body Params

other_id

ID of the other treeitem which you would like this treeitem to be packaged after.

Response

OK

Suggest Edits

partial_day_events/:id/activities

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id/activities"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required
id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_timestring

the UTC date and time of the beginning of the event

finish_timestring

the UTC date and time of the end of the event. Must be no more than 24 hours after start_time.

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to end_time

earliest_startstring

identical to start_time

expected_finishstring

identical to end_time

expected_startstring

identical to start_time

p98_finishstring

identical to end_time

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to end_time

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

parent_idinteger

ID of the parent project/folder/package

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the event

recurrence_patternstring

settings for recurrence of a partial day event

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

partial_day_events

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_timestring

the UTC date and time of the beginning of the event

finish_timestring

the UTC date and time of the end of the event. Must be no more than 24 hours after start_time.

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to end_time

earliest_startstring

identical to start_time

expected_finishstring

identical to end_time

expected_startstring

identical to start_time

p98_finishstring

identical to end_time

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to end_time

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

parent_idinteger

ID of the parent project/folder/package

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the event

recurrence_patternstring

settings for recurrence of a partial day event

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

partial_day_events

 

Header Auth

 Authentication is required for this endpoint.
posthttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events
curl --request POST \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events");

xhr.send(data);
import requests

url = "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

workspace_id
integer
required

Body Params

partialdayevent
object
 
partialdayevent.activity_id
integer

ID of the activity most recently used for tracking time against this item, suggested for use as a default

partialdayevent.assignments
string

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

partialdayevent.custom_field_values
string

hash of custom fields and their assigned values for this item

partialdayevent.start_time
string

the UTC date and time of the beginning of the event

partialdayevent.finish_time
string

the UTC date and time of the end of the event. Must be no more than 24 hours after start_time.

partialdayevent.description
string

plaintext summary of this item

partialdayevent.is_done
boolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

partialdayevent.is_on_hold
boolean

if true, then the event is on hold, and will not be scheduled

partialdayevent.is_shared
boolean

if true, then the event may be visible on a project portal

partialdayevent.manual_alert
string

editable, arbitrary string; if nonblank, generates an alert on this item

partialdayevent.max_effort
integer

limit on the number of hours of work; triggers a flag if exceeded

partialdayevent.name
string

name of this event

partialdayevent.parent_id
integer

ID of the parent project/folder/package

partialdayevent.external_reference
string

arbitrary string; use e.g. to store a reference ID from an external system

partialdayevent.package_id
integer

ID of the package the event belongs to, if any

Response

OK

activity_idinteger

ID of the activity most recently used for tracking time against this item, suggested for use as a default

workinteger

sum of the work tracked against this item

alertsstring

list of zero or more alerts for this item

assignmentsstring

array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS. To modify assignments on existing treeitems, use the update_assignment action.

project_idinteger

ID of the project containing this item, if any

client_idinteger

ID of the client associated with this item's project, if any

client_namestring

Name of the client associated with this item's project, if any

created_atstring
created_byinteger
custom_field_valuesstring

hash of custom fields and their assigned values for this item

done_onstring

the date on which this item was completed, defaulted to today if the item is marked done today

started_onstring

the date on which this item was started

start_timestring

the UTC date and time of the beginning of the event

finish_timestring

the UTC date and time of the end of the event. Must be no more than 24 hours after start_time.

descriptionstring

plaintext summary of this item

earliest_finishstring

identical to end_time

earliest_startstring

identical to start_time

expected_finishstring

identical to end_time

expected_startstring

identical to start_time

p98_finishstring

identical to end_time

global_priorityinteger

overall rank within the folder tree ("organize")

global_package_priorityinteger

overall rank within the package tree ("prioritize")

has_noteboolean

true if the item has a note

high_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

is_doneboolean

if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied

is_on_holdboolean

if true, then the event is on hold, and will not be scheduled

effective_is_on_holdstring

if true, then the event is on hold, and will not be scheduled

is_packaged_versionstring

if true, then this is the packaged version of a packaged item

is_sharedboolean

if true, then the event may be visible on a project portal

latest_finishstring

identical to end_time

low_effort_remaininginteger

calculated as the availability of the event owner for the duration of the event

manual_alertstring

editable, arbitrary string; if nonblank, generates an alert on this item

max_effortinteger

limit on the number of hours of work; triggers a flag if exceeded

namestring

name of this event

parent_idinteger

ID of the parent project/folder/package

external_referencestring

arbitrary string; use e.g. to store a reference ID from an external system

package_idinteger

ID of the package the event belongs to, if any

parent_idsinteger

array containing parent_id plus all ancestor ids (including root)

parent_crumbsstring

array containing name of parent plus all ancestor names

package_idsinteger

array containing package_id plus all package ancestor ids (including root)

package_crumbsstring

array containing name of package plus all package ancestor names

occurrencesstring

array of schedules for each occurrence of the event

recurrence_patternstring

settings for recurrence of a partial day event

space_idinteger

space ID

updated_atstring
updated_byinteger
item_emailstring
billable_expensesstring

The total of all billable lineitem expenses associated with this treeitem.

nonbillable_expensesstring

The total of all nonbillable lineitem expenses associated with this treeitem.

total_expensesstring

The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.

Suggest Edits

partial_day_events/:id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id
curl --request GET \
  --url https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.liquidplanner.com/api/v1/workspaces/workspace_id/partial_day_events/id");

xhr.