Get Started
Portal api methods
Help

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

Description

Returns the list of tasks matching the creteria specified in the request

Parameters
Name Description Type Example
responsibleid
sent in url
Task responsible
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
categoryid
sent in url
Task category ID
optional
number 1234
isClosed
sent in url
Show open or closed tasks only
optional
Bool value true
fromDate
sent in url
Earliest task due date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in url
Latest task due date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
entityType
sent in url
Related entity type string some text
entityid
sent in url
Related entity ID number 1234
Example
GET api/2.0/crm/task/filter?responsibleid=9924256A-739C-462b-AF15-E652A3B1B6EB&categoryid=1234&fromDate=2008-04-10T06-30-00.000Z&toDate=2008-04-10T06-30-00.000Z&entityType=some+text&entityid=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Task list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2019-12-12T20:36:51.7993381Z",
      "title": "Send a commercial offer",
      "deadLine": "2019-12-12T20:36:51.7993381Z",
      "responsible": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "category": {
        "imagePath": "path to image",
        "title": "Appointment",
        "description": "",
        "sortOrder": 2,
        "id": 30
      },
      "canEdit": true,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2019-12-12T20:36:51.7993381Z</created>
    <title>Send a commercial offer</title>
    <deadLine>2019-12-12T20:36:51.7993381Z</deadLine>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <category>
      <imagePath>path to image</imagePath>
      <title>Appointment</title>
      <description></description>
      <sortOrder>2</sortOrder>
      <id>30</id>
    </category>
    <canEdit>true</canEdit>
    <id>0</id>
  </response>
</result>