Filters

You can filter the GET endpoints responses for TeamFolders, Files, Actions, Links, and Groups using the filter query string parameter.

Filtering follows the following format:

?filter[{fieldname}]={value}

Here, the fieldname can be a type, name, ID, or any of the resource's attributes or metadata, and the value is the value you are filtering against. Depending on the endpoint, you can apply a filter.

For example, To filter the image files from the folder should be given as follows filter[type]=images.

File Filter

Resource Filter

NameDescription
allRetrieves all available resources.
allfilesRetrieves all files.
documentsRetrieves only document files.
spreadsheetsRetrieves only spreadsheet files.
presentationsRetrieves only presentation files.
pdfRetrieves only PDF files.
audioRetrieves only audio files.
videoRetrieves only video files.
imagesRetrieves only image files.
folderRetrieves all folders.
mydraftsRetrieves all files and folders in draft status.
documents_nativeRetrieves only native (Zoho Writer) document files.
spreadsheets_nativeRetrieves only native (Zoho Sheet) spreadsheet files.
presentations_nativeRetrieves only native (Zoho Show) presentation files.
documents_non_nativeRetrieves only non-native document files.
spreadsheets_non_nativeRetrieves only non-native spreadsheet files.
presentations_non_nativeRetrieves only non-native presentation files.

Team Folder Filter

NameDescription
userjoinedwsRetrieves all team folders that the user belongs to.

Action Filter

Action IDAction
0Read / Preview
1Download
101Upload
102Create
103Edit
501Share
503Unshare

Link Filter

TypeDescription
customRetrieves links shared with customized properties.
downloadRetrieves all download-enabled links.

Group Filter

Type IDGroup Name
1WorkDrive Group
2Zoho One Group