Paper is moving into the Dropbox File System. This guide will help you migrate from the Paper API to Paper in the Dropbox API.
Starting in September 25 2019, new Paper users will see Paper docs they create as
.paper files alongside their Dropbox content in the filesystem. This is part of an effort to ensure consistency with where Dropbox and Paper content are stored, and their associated sharing and permissions.
As part of this change, any existing
/paper/ API endpoints that interact directly with Paper content won’t work for new users whose Paper content is stored alongside their Dropbox content. Instead, the associated
/sharing/ equivalent API endpoint should be used to interact with a user’s Paper content. Read on for a full list of API endpoints that you should start using to fetch this new
.paper file type.
A few other things to note:
/paper/endpoints to work with Paper docs created by existing Paper users.
The following timeline and guide will help you migrate from using
/paper/ endpoints to their equivalent
/files/ endpoints to work with a user’s Paper docs in the Dropbox file system:
September 25th, 2019
.paperfiles alongside their other Dropbox content.
.paperfiles and will eventually migrate all users in September 2020. Once migrations begin, you can check the state of a user (i.e. where their created Paper docs are stored) using the endpoint mentioned in the next section.
/archiveendpoints will not have a Dropbox API equivalent so you won’t be able to programmatically create, update or archive Paper docs.
September 25th, 2019
.paperfiles for any Paper docs created by a Dropbox account created on or after September 25. Read more about the behavior and limitations of
.paperfiles and other online-only files in this blog post.
/updateendpoint will be retired so you can no longer use them.
For a Dropbox account created on or after September 25, 2019, new Paper docs created will be stored in the user’s file system as
.paper files alongside their other Dropbox content.
You can check this using the
users/features/get_values endpoint and looking for the feature called
Note that it is possible for a user to interact with
.paper files (Paper docs that reside in their filesystem) and legacy Paper docs (the old model). If you want to fetch all docs that a user has access to, you’ll need to use both the Paper API and the Dropbox API.
|Paper API||Dropbox API|
|/paper/docs/folder_users/list||Use /files/get_file_metadata to fetch the doc’s containing folder, then use /sharing/list_folder_members to fetch the folder’s members.|
|/paper/docs/list||/files/list_folder (start with the root path with recursive set to True, and then do client-side filtering if you just want the Paper docs)|
The following endpoints don’t have a Dropbox API equivalent. This means that these actions will not be available for new Paper users created on or after September 25, 2019:
/files/deleteendpoint instead. An important difference between deleted docs and archived docs is that deleted docs are scheduled to be permanently removed based on the user’s file retention policy (see article) whereas archived docs will indefinitely remain in an archive state and will show up in Paper search results.
These endpoints will return an error in the following scenarios:
Until then, you can still use these endpoints to create, update, and archive Paper docs for existing Paper users (users whose created docs are not in the Dropbox filesystem).