The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
Keyword to search file items from drive
Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9
The number of results per page
Allow images only in response
Find by userId
Filter using from-date
Filter using to-date
Filter using tagIds
Success
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-13T14: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": []
}Search result meta data
Search file items from drive
The file ID
The file name
The file type
The file URL
The date the file was uploaded
The ID of user who uploaded the file
The file size
The file height
The file width
The file title
The alternative text
This denotes the file is starred or not
The parent folder ID
The tagIds associated with the file
Total file count
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
Kindly verify the status and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.