Skip to main content
GET
/
evault
/
v1
/
favourite
/
folders
List Favourite Folder
curl --request GET \
  --url https://api.example.com/evault/v1/favourite/folders/ \
  --header 'api-key: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "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

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]