Get Started
Portal api methods
Help

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

Description

Returns the list of all cases matching the parameters specified in the request

Parameters
Name Description Type Example
contactid
sent in url
Contact ID
optional
number 1234
isClosed
sent in url
Case status
optional
Bool value true
tags
sent in url
Tags
optional
Collection of strings
collection
some text
Example
GET api/2.0/crm/case/filter?contactid=1234&tags=%5b%22some+text%22%5d
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Case 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-08-19T01:39:26.2195197Z",
      "title": "Exhibition organization",
      "isClosed": false,
      "isPrivate": false,
      "canEdit": true,
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2019-08-19T01:39:26.2195197Z",
          "fieldType": 5,
          "position": 10,
          "mask": "",
          "id": 0
        }
      ],
      "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-08-19T01:39:26.2195197Z</created>
    <title>Exhibition organization</title>
    <isClosed>false</isClosed>
    <isPrivate>false</isPrivate>
    <canEdit>true</canEdit>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2019-08-19T01:39:26.2195197Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <id>0</id>
  </response>
</result>