TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

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

Description

Returns a list of blog posts matching the search query specified in the request with the post titles, dates of creation and update, post texts, and authors.

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

List of found posts

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Title": "Example post",
      "Created": "2020-12-03T21:36:12.0774137Z",
      "Updated": "2020-12-03T21:36:12.0774137Z",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Preview": "Preview post",
      "Tags": [
        "Tag1",
        "Tag1"
      ],
      "BlogTitle": "Blog Title"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Title>Example post</Title>
    <Created>2020-12-03T21:36:12.0774137Z</Created>
    <Updated>2020-12-03T21:36:12.0774137Z</Updated>
    <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>
    <Preview>Preview post</Preview>
    <Tags>Tag1</Tags>
    <Tags>Tag1</Tags>
    <BlogTitle>Blog Title</BlogTitle>
  </response>
</result>