---
title: "Get favorite files list"
method: GET
path: "/3/drive/{drive_id}/files/favorites"
tags: ["Drive > Files > Favorite"]
---

# Get favorite files list

`GET /3/drive/{drive_id}/files/favorites`

Return a list of favorite files

## Path parameters

- `drive_id` integer, required

## Query parameters

- `with` string
- `cursor` string — The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list
- `limit` integer — The maximum number of items returned
- `order_by` string[]
- `order` 'asc' | 'desc' — Specifies the default sorting direction for any `order_by` parameters provided
- `order_for` string[]
- `type` string[]

## Response `200`

OK

- object
  - `result` 'success' | 'error' | 'asynchronous', required — Result of the HTTP request
  - `data` 91ac10ffDirectoryV3[]
    - `id` integer, required — Unique identifier of the resource `Directory V3`
    - `name` string, required — File name
    - `sorted_name` string — Specific sortable name
    - `path` string — Full path of the Directory V3
    - `type` 'dir' | 'file', nullable, required — Type of returned element either a dir (Directory) or file (File)
    - `status` 'locked' | 'ok' | 'trash_inherited' | 'trashed' | 'uploading', required — Current state of Directory V3. The state can be null meaning that the Directory V3 has no specific state.<note><strong>locked</strong>: Directory V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).</note><note><strong>ok</strong>: Directory V3 is available.</note><note><strong>trash_inherited</strong>: Directory V3 is currently in trash because a parent directory was trashed.</note><note><strong>trashed</strong>: Directory V3 is currently in trash and specifically trashed by the user.</note><note><strong>uploading</strong>: Directory V3 is currently being uploaded. The Directory V3 is locked and no action can be done excepting upload actions.</note>
    - `visibility` '' | 'is_in_private_space' | 'is_in_shared_space' | 'is_in_team_space_folder' | 'is_private_space' | 'is_root' | 'is_shared_space' | 'is_team_space' | 'is_team_space_folder', required — Visibility of Directory V3, empty string if no specific visibility. Add additional information about Directory V3 to show different icons or more.<note><strong></strong>: Empty visibility mean no special visibility.</note><note><strong>is_in_private_space</strong>: Is a Directory V3 inside the private directory of the user.</note><note><strong>is_in_shared_space</strong>: Is a Directory V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.</note><note><strong>is_in_team_space_folder</strong>: Is a Directory V3 inside a Common Documents directory.</note><note><strong>is_private_space</strong>: Is the private directory of the user.</note><note><strong>is_root</strong>: Is the root directory of the user.</note><note><strong>is_shared_space</strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.</note><note><strong>is_team_space</strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.</note><note><strong>is_team_space_folder</strong>: Is the root directory inside the Common Documents.</note>
    - `drive_id` integer, required — Drive identifier
    - `depth` integer, required — Current path depth of Directory V3
    - `created_by` integer, nullable, required — The identifier of the user who first uploaded the Directory V3
    - `created_at` integer, nullable, required — Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload
    - `added_at` integer, required — The timestamp (in seconds) at which the Directory V3 has been uploaded for the first time
    - `last_modified_at` integer, required — Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload
    - `last_modified_by` integer, nullable, required — Id of the user who last modified the Directory V3
    - `revised_at` integer, required — The last time the content of the Directory V3 was revised
    - `updated_at` integer, required — The last time the Directory V3 was updated
    - `parent_id` integer, required — Parent directory identifier
    - `deleted_at` integer — Timestamp of deleted resource Directory V3, only visible when the Directory V3 is trashed
    - `deleted_by` integer — User identifier of deleted resource Directory V3, only visible when the Directory V3 is trashed
    - `shared_root_id` integer, nullable — Root Directory identifier, only visible for shared user
    - `parents` 91ac10ffDirectoryV3[] — Get all parents directories
    - `users` integer[] — Array of users identifiers that has access to the Directory V3
    - `teams` integer[] — Array of teams identifiers that has access to the Directory V3
    - `is_favorite` boolean — Is Directory V3 pinned as favorite
    - `activity` object — Activities information about the Directory V3
      - `last_accessed_at` integer, required — Timestamp of the last user access of the Directory V3
    - `sharelink` 91ac10ffShareLink
      - `url` string, required — Share link url
      - `file_id` integer, required
      - `right` 'inherit' | 'password' | 'public', required — Rights required to view the share link.<note><strong>inherit</strong>: Share link is accessible only by users of the drive.</note><note><strong>password</strong>: Share link is public but protected by a password.</note><note><strong>public</strong>: Share link is public, no restriction set.</note>
      - `valid_until` integer, nullable, required — Until when the share link is valid
      - `created_by` integer, required — Unique identifier of the creator of the resource `Share Link`
      - `created_at` integer, nullable, required — Timestamp `Share Link` was created at
      - `updated_at` integer, nullable, required — Timestamp `Share Link` was updated at
      - `capabilities` object, required
        - `can_edit` boolean, required — Does share link allow editing
        - `can_see_stats` boolean, required — Does share link allow stats to be seen
        - `can_see_info` boolean, required — Does share link allow info to be seen
        - `can_download` boolean, required — Does share link allow download
        - `can_comment` boolean, required — Does share link allow adding comments
        - `can_request_access` boolean, required — Does share link allow user to request access to folder
      - `access_blocked` boolean, required — If the share link is blocked
      - `views` integer, nullable — Number of views of share link (last 180 days only)
    - `capabilities` object — Directory rights
      - `can_use_favorite` boolean, required — Right to set file as favorite
      - `can_become_sharelink` boolean, required — Right to share file by link (share_link)
      - `can_use_team` boolean, required — Right to use and give team access
      - `can_show` boolean, required — Right to see Directory V3 information
      - `can_read` boolean, required — Right to read Directory V3 content
      - `can_write` boolean, required — Right to write Directory V3
      - `can_share` boolean, required — Right to share Directory V3 or manage access to Directory V3
      - `can_leave` boolean, required — Right to leave shared Directory V3
      - `can_delete` boolean, required — Right to delete Directory V3
      - `can_rename` boolean, required — Right to rename Directory V3
      - `can_move` boolean, required — Right to move Directory V3
      - `can_create_directory` boolean, required — Right to add new child directory
      - `can_create_file` boolean, required — Right to add new child file
      - `can_upload` boolean, required — Right to upload a child file
      - `can_move_into` boolean, required — right to move directory
      - `can_become_dropbox` boolean, required — Right to use convert directory into collaborative directory
      - `colorable` boolean, required — Right to change or add color to the directory
    - `lock` object — When Directory V3 is locked, locked information
      - `locked_at` integer, nullable, required — When Directory V3 is locked, locked timestamp
      - `unlocked_at` integer, nullable, required — When Directory V3 is locked, automatic lock release timestamp
      - `description` '365' | 'external_import' | 'internal_copy' | 'internal_import' | 'onlyoffice' | 'unknown' | 'webdav', nullable, required — List of applications.<note><strong>365</strong>: The 365 application.</note><note><strong>external_import</strong>: The external_import application.</note><note><strong>internal_copy</strong>: The internal_copy application.</note><note><strong>internal_import</strong>: The internal_import application.</note><note><strong>onlyoffice</strong>: The onlyoffice application.</note><note><strong>webdav</strong>: The webdav application.</note>
      - `token` string, nullable, required — When Directory V3 is locked, locked token
    - `categories` 91ac10ffFileCategory[] — File categories
      - `category_id` integer, required — Category identifier
      - `added_at` integer, required — Time when the category was added to file
      - `user_validation` 'CORRECT' | 'INCORRECT' | 'TO_VALIDATE', nullable, required — State of user validation after auto assignment from AI.
      - `is_generated_by_ai` boolean, required — Whether the Category was generated by an AI or not
      - `user_id` integer, nullable, required — User identifier
      - `category` 91ac10ffCategory
        - `id` integer, required — Category identifier
        - `name` string, required — Category name
        - `color` string, required — Color the Category displays in
        - `is_predefined` boolean, required — If the Category is system or user defined
        - `created_by` integer, required — Unique identifier of the creator of the resource `Category`
        - `created_at` integer, required — Timestamp `Category` was created at
        - `user_uses` integer — Number of uses of the Category
    - `etag` string, nullable — ETag of the file
    - `color` string, nullable, required — Color of the directory for the user requesting it
    - `dropbox` 91ac10ffDropbox
      - `id` integer, required — Unique identifier of the resource `Dropbox`
      - `uuid` string, required — Dropbox unique identifier
      - `name` string, required — Name of the dropbox
      - `url` string, required — Public URL of the dropbox
      - `directory` 91ac10ffDirectoryV3 — recursive
      - `users_count` integer, required — Number of recorded users that uploaded in the dropbox
      - `created_by` integer, required — Unique identifier of the creator of the resource `Dropbox`
      - `created_at` integer, nullable, required — Timestamp `Dropbox` was created at
      - `updated_at` integer, nullable, required — Timestamp `Dropbox` was updated at
      - `last_uploaded_at` integer, nullable, required — Last time someone uploaded a file in the dropbox
      - `capabilities` object, required
        - `has_password` boolean, required — A password was defined to access to the dropbox
        - `has_notification` boolean — Notification was enabled on the dropbox, email we be send to dropbox owner when someone upload a file
        - `has_validity` boolean, required — A validity period was set to the dropbox, after the date define the dropbox is not accessible
        - `has_size_limit` boolean, required — A limit size was defined to the dropbox, after the date define the dropbox is not accessible
        - `validity` string
        - `size` string
      - `user` 91ac10ffAppUser
        - `id` integer, required — Unique identifier of the resource `App User`
        - `display_name` string, required — Display name
        - `first_name` string, required — First name
        - `last_name` string, required — Last name
        - `email` string, required — Email
        - `is_sso` boolean, required — returns true if the user is provided by an external IDP
        - `avatar` string, nullable, required — null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar
        - `type` string
        - `deleted_at` integer, nullable, required — Timestamp `App User` was deleted at
        - `teams` integer[] — List of Team identifiers
        - `security` object
          - `assistant_at` integer, nullable, required — The last date the assistant was used
          - `double_auth_method` string, required — Double authentication method used to log in
          - `has_double_auth` boolean, required — Whether the `App User` has double authentication enabled
          - `last_password_at` integer, nullable, required — Last time `App User`'s password was changed
          - `score` integer, required — Security score of the `App User`
          - `has_valid_email` integer, required — Whether the `App User` has a valid email
          - `has_recovery_email` boolean, required — Whether the `App User` has a recovery email
          - `has_valid_phone` boolean, required — Whether the `App User` has a valid phone number
    - `external_import` 91ac10ffExternalImport
      - `id` integer, required — External import identifier
      - `application` 'dropbox' | 'kdrive' | 'kdrive_sharelink' | 'onedrive', required — Service from which the import originates.<note><strong>dropbox</strong>: Import from Dropbox.</note><note><strong>kdrive</strong>: Import from another kDrive.</note><note><strong>kdrive_sharelink</strong>: Import from a kDrive sharelink.</note><note><strong>onedrive</strong>: Import from Microsoft OneDrive.</note>
      - `account_name` string, required — Account imported
      - `status` 'canceled' | 'canceling' | 'done' | 'failed' | 'in_progress' | 'queued' | 'waiting', required — External import status.<note><strong>canceled</strong>: External import was canceled.</note><note><strong>canceling</strong>: External import is being canceled.</note><note><strong>done</strong>: External import is finished.</note><note><strong>failed</strong>: External import failed.</note><note><strong>in_progress</strong>: External import is currently in progress.</note><note><strong>queued</strong>: External import is waiting for a process to handle it.</note><note><strong>waiting</strong>: External import has not started yet.</note>
      - `error_code` string — Give an error code if the failed reason is known.
      - `path` string, required — Import path destination
      - `directory_id` integer, nullable, required — Import directory identifier destination (if was not deleted)
      - `has_shared_files` string, required — Import application has shared files
      - `created_at` integer, required — Timestamp `External Import` was created at
      - `updated_at` integer, required — Timestamp `External Import` was updated at
      - `count_success_files` integer, required — Number of successfully imported files
      - `count_failed_files` integer, required — Number of failed imported files
    - `rewind` 91ac10ffRewindV3
      - `id` integer, required — Rewind identifier
      - `status` 'canceled' | 'done' | 'drive_not_ready' | 'expired' | 'failed' | 'in_progress' | 'new' | 'sanitizing' | 'waiting_approval', required — Rewind status.<note><strong>canceled</strong>: Rewind was canceled by the user and deleted.</note><note><strong>done</strong>: Rewind completed successfully.</note><note><strong>drive_not_ready</strong>: Rewind cannot start because the drive was not ready (uploads or actions in progress).</note><note><strong>expired</strong>: Rewind has expired and deleted.</note><note><strong>failed</strong>: Rewind completed with errors.</note><note><strong>in_progress</strong>: Rewind is currently in progress.</note><note><strong>new</strong>: Rewind did not start.</note><note><strong>sanitizing</strong>: Rewind find the activity to sanitize.</note><note><strong>waiting_approval</strong>: Rewind waiting user approval to continue.</note>
      - `mode` 'directory' | 'drive' | 'user', required — Rewind type.<note><strong>directory</strong>: Rewind only a directory.</note><note><strong>drive</strong>: Rewind all the drive.</note><note><strong>user</strong>: Rewind a user's private folder.</note>
      - `archiving` 'all' | 'current' | 'none', nullable, required — Rewind archive mode, all created files between now and the rewind date will be set to trash or to an archive depending on the mode selected.<note><strong>all</strong>: Keep in an archive folder the current or trashed files.</note><note><strong>current</strong>: Keep in an archive folder the current files.</note><note><strong>none</strong>: Don't build an archive, trash all created files.</note>
      - `directory_id` integer, nullable, required — The targeted directory of the rewind <note>Filled only in directory and user mode</note>
      - `directory` 91ac10ffDirectoryV3 — recursive
      - `directory_name` string — The name of the directory selected when the directory mode is selected
      - `user_id` integer, nullable, required — The targeted user of the rewind <note>Filled only in user mode</note>
      - `rewind_at` integer, required — Rewind at
      - `created_at` integer, required — created at
      - `finished_at` integer — when the rewind is executed the finished process time is save here
      - `expires_at` integer, required — Date of the rewind approval
      - `created_by` integer, required — created by the user
      - `is_approved` boolean, required — Rewind approved by the user
      - `approval_at` integer, required — Date of the rewind approval
      - `rewind_name` string — The name of the directory choose during approval step
      - `sanitizer` object — Sanitizer resume, returned only when the rewind has done the sanitizing process
        - `sanitized` integer, required
        - `total` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `team` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `me` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `others` string
      - `summary` object — Rewind resume, returned only when the rewind is finished
        - `total` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
        - `team` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
          - `directory_id` integer, nullable, required
          - `directory_archive_id` integer, nullable, required
          - `directory_conflict_id` integer, nullable, required
        - `me` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
          - `directory_id` integer, nullable, required
          - `directory_archive_id` integer, nullable, required
          - `directory_conflict_id` integer, nullable, required
        - `others` 91ac10ffRewindSummaryFileCounter[]
          - `user_id` integer, required — User id
          - `executed` integer, required — Total of actions executed
          - `archived` integer, required — Total of actions archived
          - `conflicted` integer, required — Total of actions conflicted
  - `cursor` string, nullable, required — Cursor pagination uses a cursor to track the current position in the dataset. This cursor should be passed back in the subsequent API request in order to retrieve the next set of results or page of the list.
  - `has_more` boolean, required — The has_more boolean flag indicates whether additional items are available beyond the current page of results.
  - `response_at` integer, required — The timestamp, in seconds, indicating when the dataset was generated.

## Other responses

- `403` — Forbidden
- `503` — Service Unavailable

---

[API](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools.md) · [All operations](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infomaniak/api-reference-developer-tools/revisions/667aae28fec6/schema)