Search Documents

Searches for documents by name, keyword, or content, optionally scoped to a specific team, sorted by a chosen field, and filtered by a modified or creation date range.

Endpoints

get https://www.zohoapis.com/writer/api/v1/documents/search

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALL, ZohoSearch.securesearch.READ, WorkDrive.team.READCopied!

curl --request GET \
  --url 'https://www.zohoapis.com/writer/api/v1/documents/search?query=Invoice_2026&team_id=SOME_STRING_VALUE&offset=0&limit=50&sortby=SOME_STRING_VALUE&sort_order_by=SOME_STRING_VALUE&date_type=SOME_STRING_VALUE&start_time=SOME_INTEGER_VALUE&end_time=SOME_INTEGER_VALUE' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'


    parameters = "query=value" + "&" + "team_id=value" + "&" + "offset=value" + "&" + "limit=value" + "&" + "sortby=value" + "&" + "sort_order_by=value" + "&" + "date_type=value" + "&" + "start_time=value" + "&" + "end_time=value";

    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/documents/search" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

Query Parameters

querystring(Required)

The search term to look for in document names, keywords, or content.

Maximum Length :10000Copied!

team_idstring(Optional)

The unique ID of the team within which to scope the search.

offsetinteger(Optional)

The starting position for the search results.

Default Value :0Copied!

limitinteger(Optional)

The maximum number of results to return.

Default Value :50Copied!

sortbystring(Optional)

The field to sort results by. No sort is applied downstream if this parameter is omitted.

Allowed Values :

Show Values ▾

sort_order_bystring(Optional)

The sort direction. Has no effect unless sortby is also specified; if sortby is omitted, this parameter is silently ignored.

Allowed Values :

Show Values ▾

Default Value :descendingCopied!

date_typestring(Optional)

Filters results by a modified/creation date range. Only applies for WorkDrive-integrated accounts. Required alongside start_time and end_time when set to custom_date.

Allowed Values :

Show Values ▾

start_timelong(Optional)

The start of the custom date range, in Unix epoch milliseconds. Required when date_type is custom_date.

end_timelong(Optional)

The end of the custom date range, in Unix epoch milliseconds. Required when date_type is custom_date.

  {
    "documents": [
      {
        "document_name": "Presales tips",
        "open_url": "https://writer.zoho.com/writer/open/1x3q99f2155c6737241ea929eb72ad141da7c",
        "is_favourite": false,
        "thumbnail_url": "https://writer.zoho.com/writer/thumbnail/1x3q99f2155c6737241ea929eb72ad141da7c",
        "document_id": "1x3q99f2155c6737241ea929eb72ad141da7d",
        "type": "document",
        "modified_time": "2020-06-23T10:13:11Z",
        "download_url": "https://writer.zoho.com/writer/api/v1/download/1x3q99f2155c6737241ea929eb72ad141da7c",
        "lastmodified_by": [
          {
            "email_id": "amelia@zylker.com",
            "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1234&fs=thumb",
            "user_id": "456215787",
            "timezone": "Asia/Kolkata",
            "language": "en",
            "display_name": "Amelia"
          }
        ],
        "created_time": "2020-06-16T08:46:40Z",
        "last_opened_time": "2020-06-16T08:46:40Z",
        "created_by": "Amelia",
        "created_time_ms": 1592297200540,
        "preview_url": "https://writer.zoho.com/writer/zwpreview/1x3q99f2155c6737241ea929eb72ad141da7c",
        "creator_id": "53884257",
        "name": "New Document"
      }
    ],
    "total_count": 33
  }

▼ Show full