Gets folders information

Prev Next
Get
/v2/Drive/Folders
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Responses
200

Success

Success status response

Here, you can verify the folder’s information.

{
  "data": [
    {
      "id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
      "title": "Document",
      "parent_folder_id": "fsf41c-0f94-4b04-a8b6-a14bb1995eca",
      "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
        }
      ],
      "items_count": 1,
      "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
      "updated_on": "2024-06-13T14:30:00Z",
      "order": 1,
      "is_starred": true
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (MediaFoldersDataCustomer) | null

Dive folders meta

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

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 given folder is valid and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
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