Get Started
Usage API
More information

GET api/2.0/project/milestone/filter This function requires authentication

Description

Returns a list of all the milestones matching the parameters specified in the request.

Parameters
Name Description Type Example
projectid
sent in url
Project ID
optional
number 1234
tag
sent in url
Project tag
optional
number 1234
status
sent in url
Milestone status (Open or Closed)
optional
milestone status Open = 0, Closed = 1, Late = 2, Disable = 3
deadlineStart
sent in url
Minimum value of task deadline
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
deadlineStop
sent in url
Maximum value of task deadline
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
taskResponsible
sent in url
Task responsible GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
lastId
sent in url
Last milestone ID number 1234
myProjects
sent in url
Returns milestones only from my projects Bool value true
milestoneResponsible
sent in url
Milestone responsible GUID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Example
GET api/2.0/project/milestone/filter?projectid=1234&tag=1234&deadlineStart=2008-04-10T06-30-00.000Z&deadlineStop=2008-04-10T06-30-00.000Z&lastId=1234&myProjects=True&milestoneResponsible=9924256A-739C-462b-AF15-E652A3B1B6EB
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of milestones

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "canEdit": true,
      "canDelete": false,
      "id": 10,
      "title": "Sample Title",
      "description": "Sample description",
      "projectOwner": {
        "id": 123,
        "title": "Sample project",
        "status": 0,
        "isPrivate": false
      },
      "deadline": "2021-10-22T16:42:23.7744989Z",
      "isKey": false,
      "isNotify": false,
      "activeTaskCount": 15,
      "closedTaskCount": 5,
      "status": 0,
      "responsible": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updatedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2021-10-22T16:42:23.7744989Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2021-10-22T16:42:23.7744989Z"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>true</canEdit>
    <canDelete>false</canDelete>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <projectOwner>
      <id>123</id>
      <title>Sample project</title>
      <status>0</status>
      <isPrivate>false</isPrivate>
    </projectOwner>
    <deadline>2021-10-22T16:42:23.7744989Z</deadline>
    <isKey>false</isKey>
    <isNotify>false</isNotify>
    <activeTaskCount>15</activeTaskCount>
    <closedTaskCount>5</closedTaskCount>
    <status>0</status>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2021-10-22T16:42:23.7744989Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2021-10-22T16:42:23.7744989Z</updated>
  </response>
</result>