List Milestones on a Project
This lets you query the list of milestones for a project. You can set the "find" option to return only those milestones that are incomplete, completed, upcoming or late. By default all milestones will be returned.This call uses pagination. 100 milestones are returned per page.
Path Params
- Name
id- Type
- string
- required
- Description
Query Params
- Name
pageSize- Type
- integer
- Description
The amount of Milestones returned can be limited using this parameter. Normally used in conjunction with the page parameter.
Maximum: 400
- Default
100
- Name
page- Type
- integer
- Description
Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.
See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.
- Name
find- Type
- string
- Description
Find certain milestones. Options: al|,complete,incomplete,late,upcoming
- Name
getProgress- Type
- boolean
- Description
Use this parameter to return a field percentageComplete
- Default
false
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
200 Response
{
"milestones": [
{
"project-id": "999",
"canComplete": true,
"responsible-party-id": "999",
"completer-id": "999",
"comments-count": "0",
"private": false,
"status": "completed",
"completed-on": "2014-02-27T18:24:59Z",
"created-on": "2014-02-25T14:56:54Z",
"canEdit": true,
"responsible-party-type": "Person",
"isprivate": "no",
"company-name": "Demo 1 Company",
"id": "999",
"last-changed-on": "2014-02-27T18:25:20Z",
"completed": true,
"reminder": "no",
"tasklists": [],
"description": "",
"responsible-party-firstname": "'Demo",
"completer-firstname": "'Demo",
"responsible-party-ids": "999",
"responsible-party-names": "'Demo ",
"responsible-party-lastname": "User'",
"company-id": "999",
"creator-id": "999",
"completer-lastname": "User'",
"project-name": "Demo Project",
"deadline": "20140212",
"_isprivate": {
"deprecated": true
},
"title": "Demo Milestone"
}
]
}