Skip to main content
GET
/
evault
/
v1
/
favourite
/
folders
/
{id}
Retrieve Favourite Folder
curl --request GET \
  --url https://api.example.com/evault/v1/favourite/folders/{id}/ \
  --header 'api-key: <api-key>'
{
  "id": "<string>",
  "access": "<string>",
  "files_count": 123,
  "folders_count": 123,
  "file_size": 123,
  "file_size_unit": "<string>",
  "extension": "<string>",
  "parent_folder": "<string>",
  "path": "<string>",
  "root": true,
  "file_share_id": "<string>",
  "is_shared": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "is_starred": true,
  "is_archived": true,
  "is_deleted": true,
  "folder": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ]
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
id
string
required

A unique value identifying this file folder.

Response

200 - application/json
​
id
string
required
​
access
string | null
required
​
files_count
integer
required
​
folders_count
integer
required
​
file_size
integer
required
​
file_size_unit
string
required
​
extension
string
required
​
parent_folder
string
required
​
path
string
required
​
root
boolean
required

indicates if the folder is on the root of the folder heirachy.

​
file_share_id
string
required
​
is_shared
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
name
string | null
Maximum string length: 255
​
description
string | null
Maximum string length: 500
​
is_starred
boolean
​
is_archived
boolean
​
is_deleted
boolean
​
folder
string | null

Enclosing Folder that contain this folder, default to root.

​
tags
object[]