Bulk Export of Quip Content

You can use Quip’s Admin API to programmatically export data from your site. Documentation on our Admin API can
be found here: https://quip.com/dev/admin/documentation/current.

Steps to Export Quip Content using the Quip API:

API Preparation

• Grant yourself an Admin Role that has the “Unredacted Audit Access to All Members & Content” permission (documented here: https://help.salesforce.com/s/articleView?id=000393323&type=1)
• Create an API Key (Client ID and Client Secret) by logging into the Quip Admin Console and choosing Settings > Integrations > New API Key
• Get your Token: https://quip.com/dev/admin/documentation/current#section/Authentication/Get-Access-to-Quip's-APIs

Retrieve IDs of threads

Depending on which threads you want to export, there are several Admin API calls you can utilize:

• List Threads API call: https://quip.com/dev/admin/documentation/current#operation/listThreads
  • This API can list all threads for your site and supports paging. Choose this API if you want to export all threads of your site.
• Get threads by a user: https://quip.com/dev/admin/documentation/current#tag/Users/operation/getUserThreadsV2
  • This API can return threads which a certain user directly has access to.
• Get threads under a folder: https://quip.com/dev/admin/documentation/current#tag/Folders/operation/getFolder.
  • This API will give the IDs of threads directly under a folder. If you want to export all threads under this folder, you need to traverse all child folders of this folder to find all nested threads.

Export Quip Content to a Format

Once you have the list of thread IDs you want to export, you can export the Quip documents or spreadsheets to PDF, .docx, .xlsl or HTML. There are two types of API:

• Bulk API:
  • Scenario:
    • recommended for exporting large number of threads. The advantage is that you can submit your requests quickly and don’t have to wait for the export to be finished. For each request submitted, Quip returns a request ID which you can use to track the progress of the export of all threads belonging to that request. This is an async progress.
  • Available APIs:
    • Latest Bulk Export API(Support PDF, DOCX, XLSX, HTML):
      • Submit requests: https://quip.com/dev/admin/documentation/current#tag/Threads/operation/createBulkExportRequest
      • Track progress: https://quip.com/dev/admin/documentation/current#tag/Threads/operation/getBulkExportResponse
    • Old Bulk PDF Export API(Only support PDF format):
      • Submit requests: https://quip.com/dev/admin/documentation/current#tag/Threads/operation/createBulkExportPdfsRequest
      • Track progress: https://quip.com/dev/admin/documentation/current#tag/Threads/operation/getBulkExportPdfResponse
• Non-bulk API:
  • Scenario:
    • If you want to export a small number or maybe just several documents quickly, these non-bulk API are preferred.
  • Available APIs:
    • .docx
      • https://quip.com/dev/admin/documentation/current#operation/exportThreadToDocx
    • .xlsx
      • https://quip.com/dev/admin/documentation/current#operation/exportThreadToXlsx
    • PDF:
      • https://quip.com/dev/admin/documentation/current#tag/Threads/operation/exportThreadToPdf

Considerations for Bulk Export:

• Document Bulk Export Rate Limit - Create Bulk Export Request and Create Bulk Export PDF Request API are both subject to a per-company rate limit with a default of 36,000 documents exported per hour. If your company has a large amount of Quip content to export and your API call already hit the rate limit, please wait until next hour to submit new Bulk Export requests.
• Quip does not have a feature to export all company data in one Folder or Zip file in the native Quip Folder structure.
• Documents have different sizes and some might be exported quickly while other are still in progress. Some big documents might take some time to finish the exporting. Please use the Retrieve Bulk Export Response and Retrieve Bulk Export PDF Response to track the overall progress and the status of export of each thread in that request.