Drive search - files and folders
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Drive search - files and folders
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v2/Drive/Search
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Query parameters
searchKeyword
string
Keyword to search file items from drive
pageNo
integer (int32)
Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9
Default0
take
integer (int32)
The number of results per page
Default20
allowImagesOnly
boolean
Allow images only in response
Defaultfalse
userIds
array of string
Find by userId
filterFromDate
string (date-time)
Filter using from-date
filterToDate
string (date-time)
Filter using to-date
filterTags
array of string
Filter using tagIds
Responses
200
Success
Bad Response
This response indicates the process has been completed.
{
"data": {
"all_files": [
{
"id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"file_name": "File name",
"file_type": "Other",
"file_url": "https://file.example.com/file.png",
"updated_on": "2024-06-13T02:30:00Z",
"updated_by": "ff9c041c-0f94-4b04-a8b6-a14bb1995eca",
"size": "342",
"height": null,
"width": null,
"title": "File title",
"alternative_text": null,
"is_starred": false,
"parent_folder_id": "sdfs041c-0f94-4b04-a8b6-a14bb19fwefver",
"tag_ids": [
"e79c041c-0f94-4b04-a8b6-a14bb1995eca",
"f79c041c-0f94-4b04-a8b6-a14bb1995eca"
]
}
],
"count": 12
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
object | null
Search result meta data
all_files
Array of object (DeletedandStarredMetaDataCustomer) | null
Search file items from drive
object
id
string | null
The file ID
file_name
string | null
The file name
file_type
string | null
The file type
file_url
string | null
The file URL
updated_on
string (date-time)
The date the file was uploaded
updated_by
string | null
The ID of user who uploaded the file
size
string | null
The file size
height
string | null
The file height
width
string | null
The file width
title
string | null
The file title
alternative_text
string | null
The alternative text
is_starred
boolean
This denotes the file is starred or not
parent_folder_id
string | null
The parent folder ID
tag_ids
Array of string | null
The tagIds associated with the file
string
count
integer (int32)
Total file count
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
400
Bad Request
Bad Response
Kindly verify the status and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}object
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
Was this article helpful?
