Back to DropboxFiles - List Folder - Get Latest Cursor
A way to quickly get a cursor for the folder's state. Unlike :route:list_folder
, :route:list_folder/get_latest_cursor
doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.
Input
type: object
properties:
data:
type: object
description: >
path: A unique identifier for the file.
recursive: If true, the list folder operation will be applied recursively
to all subfolders and the response will contain contents of all
subfolders.
include_media_info: If true, :field:`FileMetadata.media_info` is set for
photo and video.
include_deleted: If true, the results will include entries for files and
folders that used to exist but were deleted.
include_has_explicit_shared_members: If true, the results will include a
flag for each file indicating whether or not that file has any explicit
members.
include_mounted_folders: If true, the results will include entries under
mounted folders which includes app folder, shared folder and team folder.
limit: The maximum number of results to return per request. Note: This is
an approximate number and there can be slightly more entries returned in
some cases.
shared_link: A shared link to list the contents of. If the link is
password-protected, the password must be provided. If this field is
present, :field:`ListFolderArg.path` will be relative to root of the
shared link. Only non-recursive mode is supported for shared link.
include_property_groups: If set to a valid list of template IDs,
:field:`FileMetadata.property_groups` is set if there exists property data
associated with the file and each of the listed templates.
properties:
shared_link:
type: object
description: |
url: Shared link url.
password: Password for the shared link.
properties:
url:
type: string
description: Shared link url.
password:
type: string
description: Password for the shared link.
include_property_groups:
type: object
description: >
filter_some: Only templates with an ID in the supplied list will be
returned (a subset of templates will be returned).
other: None
properties:
filter_some:
type: array
description: >-
Only templates with an ID in the supplied list will be returned (a
subset of templates will be returned).
items:
type: string
.tag:
title: Choice of TemplateFilterBase
type: string
enum:
- filter_some
- other
recursive:
type: boolean
description: >-
If true, the list folder operation will be applied recursively to all
subfolders and the response will contain contents of all subfolders.
include_has_explicit_shared_members:
type: boolean
description: >-
If true, the results will include a flag for each file indicating
whether or not that file has any explicit members.
include_deleted:
type: boolean
description: >-
If true, the results will include entries for files and folders that
used to exist but were deleted.
limit:
type: number
description: >-
The maximum number of results to return per request. Note: This is an
approximate number and there can be slightly more entries returned in
some cases.
include_media_info:
type: boolean
description: If true, :field:`FileMetadata.media_info` is set for photo and video.
include_mounted_folders:
type: boolean
description: >-
If true, the results will include entries under mounted folders which
includes app folder, shared folder and team folder.
path:
type: string
description: A unique identifier for the file.
title: Data
Output
type: object
description: >
cursor: Pass the cursor into :route:`list_folder/continue` to see what's
changed in the folder since your previous query.
properties:
cursor:
type: string
description: >-
Pass the cursor into :route:`list_folder/continue` to see what's changed
in the folder since your previous query.