Get Started
Usage API
More information

GET api/2.0/community/event/@search/{query} This function requires authentication

Description

Returns a list of events matching the search query specified in the request with the event titles, dates of creation and update, event types and authors.

Parameters
Name Description Type Example
query
sent in url
Search query string some text
Example
GET api/2.0/community/event/@search/some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of events

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "id": 10,
      "title": "Sample news",
      "created": "2021-10-26T01:24:23.4192599Z",
      "updated": "2021-10-26T01:24:23.4192599Z",
      "type": 1,
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      }
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>10</id>
    <title>Sample news</title>
    <created>2021-10-26T01:24:23.4192599Z</created>
    <updated>2021-10-26T01:24:23.4192599Z</updated>
    <type>1</type>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
  </response>
</result>