Get Started
Portal api methods
Help

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

Description

Returns the list with the detailed information about all the tasks matching the filter 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
Task Status
optional
task status NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5
departament
sent in url
Departament GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
participant
sent in url
Participant GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
creator
sent in url
Creator GUID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
milestone
sent in url
Milestone ID
optional
number 1234
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
lastId
sent in url
Last task ID number 1234
myProjects
sent in url
Tasks in My Projects Bool value true
myMilestones
sent in url
Tasks in My Milestones Bool value true
nomilestone
sent in url
Tasks without Milestone Bool value true
follow
sent in url
Followed tasks Bool value true
Example
GET api/2.0/project/task/filter?projectid=1234&tag=1234&departament=9924256A-739C-462b-AF15-E652A3B1B6EB&creator=9924256A-739C-462b-AF15-E652A3B1B6EB&deadlineStart=2008-04-10T06-30-00.000Z&deadlineStop=2008-04-10T06-30-00.000Z&lastId=1234&myProjects=True&myMilestones=True&nomilestone=True&follow=True
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of tasks

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "canEdit": false,
      "canCreateSubtask": false,
      "canCreateTimeSpend": false,
      "canDelete": false,
      "canReadFiles": false,
      "startDate": "2019-10-15T09:54:27.3041970Z",
      "id": 10,
      "title": "Sample Title",
      "description": "Sample description",
      "deadline": "2019-10-15T09:54:27.3041970Z",
      "priority": 1,
      "milestoneId": 123,
      "projectOwner": {
        "id": 123,
        "title": "Sample project",
        "status": 0,
        "isPrivate": false
      },
      "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": "2019-10-15T09:54:27.3041970Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2019-10-15T09:54:27.3041970Z",
      "responsibles": null
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>false</canEdit>
    <canCreateSubtask>false</canCreateSubtask>
    <canCreateTimeSpend>false</canCreateTimeSpend>
    <canDelete>false</canDelete>
    <canReadFiles>false</canReadFiles>
    <startDate>2019-10-15T09:54:27.3041970Z</startDate>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <deadline>2019-10-15T09:54:27.3041970Z</deadline>
    <priority>1</priority>
    <milestoneId>123</milestoneId>
    <projectOwner>
      <id>123</id>
      <title>Sample project</title>
      <status>0</status>
      <isPrivate>false</isPrivate>
    </projectOwner>
    <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>2019-10-15T09:54:27.3041970Z</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>2019-10-15T09:54:27.3041970Z</updated>
    <responsibles />
  </response>
</result>