Get Started
Portal api methods
Help

GET api/2.0/project/{id}/@search/{query} This function requires authentication

Description

Returns the search results for the project containing the words/phrases matching the query specified in the request

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

List of results

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "item": {
        "id": "345",
        "entityType": 0,
        "title": "Sample title",
        "description": "Sample desription",
        "created": "2019-06-20T03:26:06.3595758Z"
      },
      "owner": null
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <item>
      <id>345</id>
      <entityType>0</entityType>
      <title>Sample title</title>
      <description>Sample desription</description>
      <created>2019-06-20T03:26:06.3595758Z</created>
    </item>
    <owner />
  </response>
</result>