Qodex.ai

Quip Admin API (Current)

Number of APIs: 45

Welcome to the documentation for the Quip Admin API. This documentation describes the functionality available only in the current versions of API methods. You can also review the documentation for all API methods for information about both current and deprecated API methods.

Summary

For governance and security purposes, Quip makes available a set of APIs to enable specific users to see all content within a Quip site and to take actions against that content.

Requirements

This API requires that you have first followed the setup instructions for the Quip Automation API.

To call this API, the access token you use must be for a user who is an admin.

You must also have the admin API enabled for your quip instance. Ask your support representative if you would like this functionality enabled.

Rate Limit

Quip’s APIs are rate limited by number of requests per minute per user - with a default of 50 requests per minute. API responses include a few custom headers to aid programmers implement backoffs in their code. These headers are:

X-Ratelimit-Limit: The number of requests/min the user can make
X-Ratelimit-Remaining: The number of requests remaining this user can make within the minute - this number changes with each request.
X-Ratelimit-Reset: The UTC timestamp for when the rate limit will reset

Note: If you believe your application requires escalated rate limits please reach out to support and explain your use case and rationale.

REST API Versioning FAQ

Why do API methods get versioned?

To improve the quality and performance of API methods, Quip periodically releases new versions and deprecates older versions. Examples of changes that sometimes require creating new versions are:

  • Renaming an API method; or
  • Adding a required input field; or
  • Removing or renaming an input field; or
  • Removing an output field.

How do I know which version of an API method I’m using?

Versions are identified in the path for each API method. Examples: * Version 1: GET https://platform.quip.com/1/admin/sampleresource. * Version 2: GET https://platform.quip.com/2/admin/sampleresource.

How will I know when an API method is deprecated?

We inform you in a release note at least one year before support for an API method ends. In addition, we update the reference documentation to identify the current and deprecated versions of an API method. Our REST APIs have two versions of reference documentation: * Current: Describes the functionality available only in the current versions of methods in a REST API. * All: Describes the functionality available in both current and deprecated versions of methods in a REST API.

What should I do when an API method is deprecated?

Update your integrations so that they point to the current version instead of a deprecated version before support for an API method ends. Example scenario: * You have an integration that points to version 1 of an API method at this path: GET https://platform.quip.com/1/admin/sampleresource * Version 2 of the API method is introduced and version 1 is deprecated. * Before support for version 1 ends, you must update your integration to point to version 2 of the API method at this path: GET https://platform.quip.com/2/admin/sampleresource.

As needed, for your integrations, you can download the OpenAPI Specification (OAS) files for current and all versions of each REST API.

Authentication

  1. Threads - Get a Blob from a Thread GET {{baseUrl}}/1/admin/blob/:thread_id/:blob_id?company_id=dolore

  2. Threads - Add a Blob to a Thread POST {{baseUrl}}/1/admin/blob/:thread_id

  3. Threads - Add People to a Thread or Add a Thread to Folders POST {{baseUrl}}/1/admin/threads/add-members

  4. Messages - Get Messages for a Thread GET {{baseUrl}}/1/admin/messages/:thread_id?company_id=dolore&count=25&max_created_usec=57566125&sorted_by=DESC&sort_by=DESC&message_type=message&include_deleted=false

  5. Threads - Copy a Document or Template POST {{baseUrl}}/1/admin/threads/copy-document

  6. Threads - Delete a Thread POST {{baseUrl}}/1/admin/threads/delete

  7. Threads - Edit A Document POST {{baseUrl}}/1/admin/threads/edit-document

  8. Threads - Edit Thread Share Link Settings POST {{baseUrl}}/1/admin/threads/edit-share-link-settings

  9. Threads - Export Document to .docx GET {{baseUrl}}/1/admin/threads/:thread_id/export/docx?company_id=dolore

  10. Threads - Export Slides to .pdf GET {{baseUrl}}/1/admin/threads/:thread_id/export/pdf?company_id=dolore