Sign in
Drive > Files > Search

Search Dropbox

Search dropboxes with specific filters.

get/3/drive/{drive_id}/files/search/dropboxes

Path parameters

drive_idinteger required

Drive identifier

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

cursorstring

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

limitinteger

The maximum number of items returned

order_bystring[]
order'asc' | 'desc'

Specifies the default sorting direction for any order_by parameters provided

order_forstring[]
author_idinteger

The author of the file

categorystring

Category pattern, patterns accepted are <b>()&|</b> and combined category ids, to manage complex computing operation : <note><strong>&</strong> as synonym of AND</note> <note><strong>|</strong> as synonym of OR</note> <note><strong>()</strong> to handle priority</note>

Example:(1&2)|3
created_afterinteger

created_at must be set as custom in order to use created_after. Filter Dropbox created after timestamp. Its minimum value is drive creation timestamp.

created_at'custom' | 'last_12_months' | 'last_24_hours' | 'last_30_days' | 'last_7_days' | 'last_90_days' | 'last_month' | 'last_week' | 'last_year' | 'this_month' | 'this_week' | 'this_year' | 'today' | 'yesterday'

Creation time of the Dropbox.<note><strong>custom</strong>: Custom period from {attribute}_after to {attribute}_before params.</note><note><strong>last_12_months</strong>: Last 12 months.</note><note><strong>last_24_hours</strong>: Last 24 hours.</note><note><strong>last_30_days</strong>: Last 30 days.</note><note><strong>last_7_days</strong>: Last 7 days.</note><note><strong>last_90_days</strong>: Last 90 days.</note><note><strong>last_month</strong>: Previous month, from the first day at 00:00:00 to the last day at 23:59:59.</note><note><strong>last_week</strong>: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59.</note><note><strong>last_year</strong>: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59.</note><note><strong>this_month</strong>: Current month, from the first day at 00:00:00 to the last day at 23:59:59.</note><note><strong>this_week</strong>: Current week, from Monday at 00:00:00 to Sunday at 23:59:59.</note><note><strong>this_year</strong>: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59.</note><note><strong>today</strong>: Current day, from 00:00:00 to 23:59:59.</note><note><strong>yesterday</strong>: Previous day, from 00:00:00 to 23:59:59.</note>

Example:custom
created_beforeinteger

created_at must be set as custom in order to use created_before. Filter Dropbox created before timestamp.

expires'any' | 'no' | 'yes'

Whether the Dropbox has an expiration date

has_password'any' | 'no' | 'yes'

Whether the Dropbox has password protection

last_import_afterinteger

last_import_at must be set as custom in order to use last_import_after. Filter Dropbox last imported in after timestamp. Its minimum value is drive creation timestamp.

last_import_at'custom' | 'last_12_months' | 'last_24_hours' | 'last_30_days' | 'last_7_days' | 'last_90_days' | 'last_month' | 'last_week' | 'last_year' | 'this_month' | 'this_week' | 'this_year' | 'today' | 'yesterday'

Last import time of the Dropbox.<note><strong>custom</strong>: Custom period from {attribute}_after to {attribute}_before params.</note><note><strong>last_12_months</strong>: Last 12 months.</note><note><strong>last_24_hours</strong>: Last 24 hours.</note><note><strong>last_30_days</strong>: Last 30 days.</note><note><strong>last_7_days</strong>: Last 7 days.</note><note><strong>last_90_days</strong>: Last 90 days.</note><note><strong>last_month</strong>: Previous month, from the first day at 00:00:00 to the last day at 23:59:59.</note><note><strong>last_week</strong>: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59.</note><note><strong>last_year</strong>: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59.</note><note><strong>this_month</strong>: Current month, from the first day at 00:00:00 to the last day at 23:59:59.</note><note><strong>this_week</strong>: Current week, from Monday at 00:00:00 to Sunday at 23:59:59.</note><note><strong>this_year</strong>: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59.</note><note><strong>today</strong>: Current day, from 00:00:00 to 23:59:59.</note><note><strong>yesterday</strong>: Previous day, from 00:00:00 to 23:59:59.</note>

Example:custom
last_import_beforeinteger

last_import_at must be set as custom in order to use last_import_before. Filter Dropbox last imported in before timestamp.

querystring

The searched pattern. It should be at least 3 characters long to get relevant results.

Example:file name
query_scope'all' | 'content' | 'filename' nullable

Defines the scope of the given search query.<note><strong>all</strong>: Content and filename.</note><note><strong>content</strong>: Content only. Available only when the Drive has the can_use_content_search capability.</note><note><strong>filename</strong>: Filename only. Available only when the Drive has the can_use_content_search capability.</note>

Example:all

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

cursorstring 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_moreboolean required

The has_more boolean flag indicates whether additional items are available beyond the current page of results.

response_atinteger required

The timestamp, in seconds, indicating when the dataset was generated.

Example response

{
  "result": "success",
  "data": [
    {
      "name": "Directory V3",
      "path": "/full/path/Directory V3",
      "type": "file",
      "status": "locked",
      "drive_id": 1111,
      "depth": 3,
      "shared_root_id": 1,
      "sharelink": {
        "url": "https://kdrive.infomaniak.com/app/share/xxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "right": "inherit"
      },
      "lock": {
        "description": "365",
        "token": "onlyoffice:123456"
      },
      "categories": [
        {
          "user_validation": "TO_VALIDATE",
          "category": {
            "color": "#FF1493"
          }
        }
      ],
      "color": "#0098ff",
      "external_import": {
        "application": "dropbox",
        "status": "canceled"
      },
      "rewind": {
        "status": "canceled",
        "mode": "directory",
        "archiving": "all"
      }
    }
  ],
  "cursor": "SGVsbG8gV29ybGQ"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.