Get Started
Portal api methods
Help

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

Description

Returns the list of all contacts associated with 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/contact
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Contact list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "firstName": "Tadjeddine",
      "lastName": "Bachir",
      "company": {
        "companyName": "Food and Culture Project",
        "about": "",
        "haveLateTasks": false,
        "displayName": null,
        "isCompany": true,
        "isPrivate": false,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Programmer",
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2019-12-15T06:37:51.3679674Z",
      "about": "",
      "commonData": [
        {
          "id": 0,
          "infoType": 1,
          "category": 0,
          "data": "support@onlyoffice.com",
          "categoryName": "Home",
          "isPrimary": true
        }
      ],
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2019-12-15T06:37:51.3679674Z",
          "fieldType": 5,
          "position": 10,
          "mask": "",
          "id": 0
        }
      ],
      "haveLateTasks": false,
      "displayName": null,
      "isCompany": false,
      "isPrivate": false,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": true,
      "canDelete": true,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <firstName>Tadjeddine</firstName>
    <lastName>Bachir</lastName>
    <company>
      <companyName>Food and Culture Project</companyName>
      <about></about>
      <haveLateTasks>false</haveLateTasks>
      <displayName />
      <isCompany>true</isCompany>
      <isPrivate>false</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </company>
    <title>Programmer</title>
    <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-15T06:37:51.3679674Z</created>
    <about></about>
    <commonData>
      <id>0</id>
      <infoType>1</infoType>
      <category>0</category>
      <data>support@onlyoffice.com</data>
      <categoryName>Home</categoryName>
      <isPrimary>true</isPrimary>
    </commonData>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2019-12-15T06:37:51.3679674Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>false</isCompany>
    <isPrivate>false</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>