The following macros are not currently supported in the header:
  • style

GET /milestones/:milestone_id

Resource URL

Returns a milestone identified by milestone id.

GET /milestones/:milestone_id

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

idunsigned int A unique id assigned to the milestone
titlestring The milestone's title
descriptionstring 
standingstring e.g, 'pending', 'active', 'paused', 'complete', 'inactive'
statusunsigned int or object Returns the milestone's status id or object if you use parenthesis.
orderingunsigned int 
parentunsigned int A unique id assigned to the milestones parent milestone (if one exists).
date_createdunsigned int Unix timestamp for the time the milestone was created.
date_modifiedunsigned int 
date_startedunsigned int 
date_commencedunsigned int 
date_completedunsigned int 
date_dueunsigned int 
jobunsigned int or objectReturns the milestones job id or object if you use parenthesis. e.g, job()
managerunsigned int or objectReturns the milestones manager's staff id or object if you use parenthesis. e.g, manager()
rateint or objectReturns the milestones rate id or object if you use parenthesis.
rate_chargednumberRate charged for the milestone. Please note that if rate_id (_fields=rate) is -1, rate charged will always be zero
object_budgetunsigned intReturns the object's budget unique id if one exists
object_budget()objectReturns the object's budget object if one exists. For more information on optional object fields, please see: GET object_budgets/:object_budget_id

 

Fields that can be object indicate the field can be requested as a resource. For example.

GET /milestones/1.json?_fields=job

would return the job's id. Where as,

GET /milestones/1.json?_fields=job()

would return the jobs object, including any optional fields or objects within the parenthesis.