Get Started
Portal api methods
Help

GET api/2.0/crm/case/{caseid} This function requires authentication

Description

Returns the detailed information about the case with the ID specified in the request

Parameters
Name Description Type Example
caseid
sent in url
Case ID number 1234
Example
GET api/2.0/crm/case/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

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-06-23T18:26:26.9969788Z",
    "title": "Exhibition organization",
    "isClosed": false,
    "isPrivate": false,
    "canEdit": true,
    "customFields": [
      {
        "entityId": 14523423,
        "label": "Birthdate",
        "fieldValue": "2019-06-23T18:26:26.9969788Z",
        "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-06-23T18:26:26.9969788Z</created>
    <title>Exhibition organization</title>
    <isClosed>false</isClosed>
    <isPrivate>false</isPrivate>
    <canEdit>true</canEdit>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2019-06-23T18:26:26.9969788Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <id>0</id>
  </response>
</result>