Gets folder information by folder ID

Prev Next
Get
/v2/Drive/Folders/{folderId}
Security
API Key: api_token
Header parameter nameapi_token

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.

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

Defaultfalse
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
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-06-13T14:30:00Z",
        "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-06-13T14:30:00Z",
    "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-06-13T14:30:00Z",
        "order": 2,
        "is_starred": true
      }
    ]
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object | null

Drive folder meta data

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 | null

Extension data for customer API response

success
boolean

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.

errors
Array of object (BaseError) | null

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.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

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.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

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.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

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": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

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.

errors
Array of object (BaseError) | null

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.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

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.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

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.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.