Get Started
Portal api methods
Help

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

Description

Returns a list of events matching the search query with the event title, date of creation and update, event type and author

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": "2019-10-15T09:54:26.7758935Z",
      "updated": "2019-10-15T09:54:26.7758935Z",
      "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>2019-10-15T09:54:26.7758935Z</created>
    <updated>2019-10-15T09:54:26.7758935Z</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>