Gets folder information by folder ID
- 23 May 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Gets folder information by folder ID
- Updated on 23 May 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/v2/Drive/Folders/{folderId}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
folderId
stringRequired
The ID of the folder in Drive
Query parameters
appendSASToken
boolean
Set this to false to exclude appending SAS token for images/files
Default"False"
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
Default"0"
take
integer (int32)
The number of results per page
Default"20"
Responses
200
Success
Success status response
Here, you can verify the folder’s information using the folder ID.
{
"data": {
"id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"title": "Document",
"order": 1,
"parent_folder_id": null,
"files": [
{
"id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"file_name": "New-Image",
"file_type": "Other",
"file_url": "https://file.example.com/new-image.jpg",
"updated_on": "2024-05-23T02:28:57Z",
"updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"size": "235",
"tags": [
{
"id": "d8b65d24-ce62-407a-8463-846efc8eee93",
"tag_name": "new-tag"
}
],
"is_starred": true
}
],
"icon": null,
"items_count": 1,
"updated_on": "2024-05-23T02:28:57Z",
"updated_by": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"is_starred": false,
"folder_color": null,
"files_count": 1,
"sub_folders": [
{
"id": "d8b65d24-ce62-407a-8463-846efc8eee93",
"title": "Images",
"parent_folder_id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"sub_folders": [],
"items_count": 0,
"updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"updated_on": "2024-05-23T02:28:57Z",
"order": 2,
"is_starred": true
}
]
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
object (MediaFolderViewMetaDataCustomer)
id
string | null
The ID of the folder in Drive
title
string | null
This folder title
order
integer (int32)
The order of the folder
parent_folder_id
string | null
The parent folder ID
files
Array of object (MediaFilesMetaDataCustomer) | null
The files associated to the folder
object
id
string
The file ID
Min length1
file_name
string | null
The file name
file_type
string | null
The file tyoe
file_url
string | null
The file URL
updated_on
string (date-time)
The date file was modified
updated_by
string | null
The ID of the user who uploaded the file
size
string | null
The file size
tags
Array of object (TagsMetaDataCustomer) | null
The tags associated with file
object
id
string | null
The tag ID
tag_name
string | null
The tag name
is_starred
boolean
This denotes the file is starred or not
icon
string | null
The icon of the folder
items_count
integer (int32)
Subfolder count in the folder
updated_on
string (date-time)
The date the folder was created
updated_by
string | null
The ID of the user that created the folder
is_starred
boolean
This denotes the folder is starred or not
folder_color
string | null
The folder color
files_count
integer (int32)
The folder file count
sub_folders
Array of object (MediaFoldersDataCustomer) | null
Sub folders of the media folder
object
id
string | null
This is the folder Id
title
string | null
This is the folder title
parent_folder_id
string | null
The parent folder ID
sub_folders
Array of object (MediaFoldersDataCustomer) | null
The sub folders in the parent
object Recursive
items_count
integer (int32)
The items in the folder
updated_by
string | null
The ID of the user that created the folder
updated_on
string (date-time)
The date the folder was created
order
integer (int32)
The order of the folder
is_starred
boolean
This denotes the folder is starred or not
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
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
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object (ExtensionDataObject)
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 (ExtensionDataObject)
description
string | null
status description for customer Api response information
400
Bad Request
Bad response
Kindly verify the given folder ID is valid and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}object
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
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
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object (ExtensionDataObject)
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 (ExtensionDataObject)
description
string | null
status description for customer Api response information
Was this article helpful?
