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

Description

Returns a list of all the events matching the parameters specified in the request.

Parameters
Name Description Type Example
entityType
sent in url
Related entity type
Allowed values: opportunity, contact, or case
optional
string some text
entityId
sent in url
Related entity ID
optional
number 1234
categoryId
sent in url
Event category ID
optional
number 1234
createBy
sent in url
Event author
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
fromDate
sent in url
Earliest event due date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in url
Latest event due date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
Example
GET api/2.0/crm/history/filter?entityType=%22some+text%22&entityId=1234&categoryId=1234&createBy=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&fromDate=%222008-04-10T06-30-00.000Z%22&toDate=%222008-04-10T06-30-00.000Z%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Event 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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Created": "2020-12-13T17:13:31.5902727Z",
      "Content": "Agreed to meet at lunch and discuss the client commercial offer",
      "Category": {
        "ImagePath": "path to image",
        "id": 1234,
        "Title": "Title",
        "Description": "Description",
        "Color": "#a7fc00",
        "SortOrder": 1
      },
      "Contact": {
        "SmallFotoUrl": "url to foto",
        "MediumFotoUrl": "url to foto",
        "DisplayName": "Tadjeddine Bachir",
        "IsCompany": false,
        "AccessList": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          }
        ],
        "IsPrivate": true,
        "IsShared": false,
        "ShareType": 0,
        "Currency": {
          "Title": "Chinese Yuan",
          "Symbol": "¥",
          "Abbreviation": "CNY",
          "CultureName": "CN",
          "IsConvertable": true,
          "IsBasic": false
        },
        "CanEdit": true,
        "CanDelete": true,
        "id": 1234
      },
      "Entity": {
        "EntityType": "opportunity",
        "EntityId": 123445,
        "EntityTitle": "Household appliances internet shop"
      },
      "CanEdit": true,
      "Files": [
        {
          "RootFolderType": 2,
          "UpdatedBy": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          },
          "Created": "2020-12-13T17:13:31.5902727Z",
          "CreatedBy": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          },
          "Updated": "2020-12-13T17:13:31.5902727Z",
          "ProviderItem": true,
          "ProviderKey": "1234d",
          "ProviderId": 1234,
          "FolderId": 12334,
          "Version": 3,
          "VersionGroup": 1,
          "ContentLength": "12.06 KB",
          "PureContentLength": 12345,
          "FileStatus": 2,
          "ViewUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
          "WebUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
          "FileType": 7,
          "FileExst": ".txt",
          "Comment": null,
          "Encrypted": true,
          "Id": 857864274,
          "Title": "Some titile.txt",
          "Access": 1,
          "Shared": false
        }
      ],
      "id": 1234
    }
  ]
}

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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreateBy>
    <Created>2020-12-13T17:13:31.5902727Z</Created>
    <Content>Agreed to meet at lunch and discuss the client commercial offer</Content>
    <Category>
      <ImagePath>path to image</ImagePath>
      <id>1234</id>
      <Title>Title</Title>
      <Description>Description</Description>
      <Color>#a7fc00</Color>
      <SortOrder>1</SortOrder>
    </Category>
    <Contact>
      <SmallFotoUrl>url to foto</SmallFotoUrl>
      <MediumFotoUrl>url to foto</MediumFotoUrl>
      <DisplayName>Tadjeddine Bachir</DisplayName>
      <IsCompany>False</IsCompany>
      <AccessList>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </AccessList>
      <IsPrivate>True</IsPrivate>
      <IsShared>False</IsShared>
      <ShareType>0</ShareType>
      <Currency>
        <Title>Chinese Yuan</Title>
        <Symbol>¥</Symbol>
        <Abbreviation>CNY</Abbreviation>
        <CultureName>CN</CultureName>
        <IsConvertable>True</IsConvertable>
        <IsBasic>False</IsBasic>
      </Currency>
      <CanEdit>True</CanEdit>
      <CanDelete>True</CanDelete>
      <id>1234</id>
    </Contact>
    <Entity>
      <EntityType>opportunity</EntityType>
      <EntityId>123445</EntityId>
      <EntityTitle>Household appliances internet shop</EntityTitle>
    </Entity>
    <CanEdit>True</CanEdit>
    <Files>
      <RootFolderType>2</RootFolderType>
      <UpdatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </UpdatedBy>
      <Created>2020-12-13T17:13:31.5902727Z</Created>
      <CreatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </CreatedBy>
      <Updated>2020-12-13T17:13:31.5902727Z</Updated>
      <ProviderItem>True</ProviderItem>
      <ProviderKey>1234d</ProviderKey>
      <ProviderId>1234</ProviderId>
      <FolderId>12334</FolderId>
      <Version>3</Version>
      <VersionGroup>1</VersionGroup>
      <ContentLength>12.06 KB</ContentLength>
      <PureContentLength>12345</PureContentLength>
      <FileStatus>2</FileStatus>
      <ViewUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</ViewUrl>
      <WebUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</WebUrl>
      <FileType>7</FileType>
      <FileExst>.txt</FileExst>
      <Comment />
      <Encrypted>True</Encrypted>
      <Id>857864274</Id>
      <Title>Some titile.txt</Title>
      <Access>1</Access>
      <Shared>False</Shared>
    </Files>
    <id>1234</id>
  </response>
</result>