Get Started
Usage API
More information

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

Description

Returns a 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
myProjects
sent in url
Returns tasks only from my projects Bool value true
milestone
sent in url
Milestone ID
optional
number 1234
myMilestones
sent in url
Returns tasks only from my milestones Bool value true
nomilestone
sent in url
Returns tasks only without milestones Bool value true
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
substatus
sent in url
Custom task status
optional
number 1234
follow
sent in url
Messages only from followed tasks or not Bool value true
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
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
Example
GET api/2.0/project/task/filter?projectid=1234&myProjects=True&myMilestones=True&nomilestone=True&tag=1234&follow=True&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
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": "2021-10-21T12:03:55.1753282Z",
      "id": 10,
      "title": "Sample Title",
      "description": "Sample description",
      "deadline": "2021-10-21T12:03:55.1753282Z",
      "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": "2021-10-21T12:03:55.1753282Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2021-10-21T12:03:55.1753282Z",
      "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>2021-10-21T12:03:55.1753282Z</startDate>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <deadline>2021-10-21T12:03:55.1753282Z</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>2021-10-21T12:03:55.1753282Z</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-21T12:03:55.1753282Z</updated>
    <responsibles />
  </response>
</result>