Skip to main content

Get Directory Structure

Use this API to get directory structure of the drive

Request Body REQUIRED
askribeKey string

Your secret Askribe key. Can be obtained from your org's settings dashboard

driveId string

The id of your drive. It looks like RLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX. This can be found on your drive dashboard.

Responses
200

Returns the directory structure

Schema OPTIONAL
isSuccess boolean OPTIONAL
data object[] OPTIONAL
name string OPTIONAL

Name of the item

description string OPTIONAL

Description of the item

resourceId string OPTIONAL

The id of the item. It looks like RLIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

resourceType string OPTIONAL

Possible values: [FILE, FOLDER]

FILE or FOLDER

storageUrl string OPTIONAL

URL of the storage location of the item

size int64 OPTIONAL

Size of the item in bytes

mimeType string OPTIONAL

Mime type of the item, e.g., application/pdf, image/png

parentFolderId string OPTIONAL

Parent folder id.

isDeleted boolean OPTIONAL

Boolean indicating if the item is present in trash

tags string[] OPTIONAL

List of tag ids associated with the item

pathById string OPTIONAL

Path of the item in the drive via ids

pathByName string OPTIONAL

Path of the item in the drive via names

errorMessage string OPTIONAL
customError object OPTIONAL