Get Started
Usage API
More information

GET api/2.0/mail/crm/linked/entities This function requires authentication

Description

Returns a list of the CRM entities (contact, case, or opportunity) linked with a conversation.

Parameters
Name Description Type Example
message_id
sent in url
Message ID. It may be ID of any message included in the conversation number 1234
Example
GET api/2.0/mail/crm/linked/entities?message_id=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of entity information: {entity_id, entity_type, avatar_link, title}

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 1234,
      "Type": 1,
      "EntityTypeName": "contact"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>1234</Id>
    <Type>1</Type>
    <EntityTypeName>contact</EntityTypeName>
  </response>
</result>