List Documents

Retrieves a paginated list of documents, optionally filtered by category or document type and sorted by a chosen field.

Endpoints

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

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALLCopied!

curl --request GET \
  --url 'https://www.zohoapis.com/writer/api/v1/documents?offset=0&limit=10&sortby=SOME_STRING_VALUE&sort_order_by=SOME_STRING_VALUE&category=SOME_STRING_VALUE&resource_type=SOME_STRING_VALUE' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'


    parameters = "offset=value" + "&" + "limit=value" + "&" + "sortby=value" + "&" + "sort_order_by=value" + "&" + "category=value" + "&" + "resource_type=value";

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

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

    info response;

Query Parameters

offsetinteger(Optional)

The starting position for the list.

Default Value :0Copied!

limitinteger(Optional)

The maximum number of documents to return. Maximum allowed value is 100.

Default Value :10Copied!

Maximum Value :100Copied!

sortbystring(Optional)

The field by which to sort the results. created_time sorts by creation date, modified_time sorts by last modified date, shared_time sorts by when the document was shared, and name sorts by document name.
Defaults to modified_time, except when category is shared_to_me, in which case it defaults to shared_time.
When category is recent, this parameter is ignored and results are always sorted by modified_time descending.

Allowed Values :

Show Values ▾

sort_order_bystring(Optional)

The sort direction for the results. Defaults to descending, except when sortby is name, in which case it defaults to ascending. When category is recent, this parameter is ignored.

Allowed Values :

Show Values ▾

Default Value :descendingCopied!

categorystring(Optional)

Filters the results by ownership, access, or status. favourite returns favourited documents, trashed returns documents in the Trash, and recent returns recently accessed documents.

Allowed Values :

Show Values ▾

Default Value :allCopied!

resource_typestring(Optional)

A comma-separated list of document types to filter by. Supported values: fillable, merge, sign, label.

  {
    "offset": 2,
    "documents": [
      {
        "created_time": "2018-03-30T10:58:48Z",
        "role": "OWNER",
        "modified_time_ms": 1522411691658,
        "parent_folder_id": "40dgcFOLDER4579020",
        "collaboration_id": "1203298717956895014",
        "last_opened_time": "2018-03-30T13:54:51Z",
        "open_url": "https://writer.zoho.com/writer/open/ponaz5c1a267e61074c50a012d8e4b519c755",
        "is_favourite": false,
        "type": "document",
        "document_id": "ponaz5c1a267e61074c50a012d8e4b519c755",
        "last_opened_time_ms": 1522411691658,
        "thumbnail_url": "https://writer.zoho.com/writer/thumbnail/ponaz5c1a267e61074c50a012d8e4b519c755",
        "created_by": "Amelia",
        "document_name": "Presales tips",
        "created_time_ms": 1522407528000,
        "modified_time": "2018-03-30T13:54:51Z",
        "preview_url": "https://writer.zoho.com/writer/preview/ponaz5c1a267e61074c50a012d8e4b519c755",
        "creator_id": "4579020",
        "download_url": "https://writer.zoho.com/api/v1/download/ponaz5c1a267e61074c50a012d8e4b519c755",
        "permalink": "https://workdrive.zoho.com/file/ponaz5c1a267e61074c50a012d8e4b519c755",
        "published_url": "https://writer.zoho.com/writer/published/ponaz5c1a267e61074c50a012d8e4b519c755",
        "document_type": "document",
        "lastmodified_by": [
          {
            "email_id": "amelia@zylker.com",
            "profile_photo": "https://contacts.zoho.com/file?t=user&ID=4579020&fs=thumb",
            "user_id": "4579020",
            "timezone": "Asia/Kolkata",
            "language": "en",
            "display_name": "Amelia"
          }
        ],
        "status": "active"
      }
    ],
    "total_count": 9,
    "limit": 1
  }

▼ Show full