Quip is a document collaboration platform that structures documents and messages into entities called threads. The Quip connector enables organizations to index and search Quip documents, spreadsheets, and folders through Glean. This documentation outlines key features, necessary permissions, technical and credential requirements, and detailed setup procedures for a successful Quip integration.

​
Supported Features and Limitations

The Quip connector allows Glean to index and search core Quip content types, but there are explicit constraints on what is ingested based on API access and current implementation.

​
Supported Objects/Entities

  • Documents (Quip threads of type “document”)
  • Spreadsheets (Quip threads of type “spreadsheet”)
  • Folders (if enabled)

​
Supported API Endpoints/Features

  • Listing all threads (documents and spreadsheets) using the Quip Admin API
  • Fetching thread content and associated metadata (title, author, created/updated time, permissions)
  • Fetching folder metadata and hierarchy (when enabled)
  • Capturing document- and folder-level sharing and permissions
  • Activity/event data capture (requires Quip Events API add-on, not included in standard setup)

​
Limitations

  • The connector does not support ingesting chat rooms, thread messages (comments), or tasks
  • Folders are not indexed by default; enabling folder support may require additional configuration
  • Only data accessible via the Quip Admin API is available; personal access tokens are not supported
  • The default Quip Admin API per-user rate limit is 100 requests per minute (can be increased upon request)
  • Near real-time activity and granular events are only available with a Salesforce add-on for the Activities API

​
Requirements

Careful preparation is needed to ensure the Quip connector operates correctly, including API enablement, proper credentials, and correct administrative roles in Quip.

​
Technical Requirements

  • Quip Admin API access enabled (not enabled by default; must be requested from Salesforce)
  • Access to an active Quip instance and company administrative privileges
  • Ability to generate and manage OAuth 2.0 credentials for integration
  • (Optional) Increased Quip API rate limits for larger organizations

​
Credential Requirements

  • Quip Client ID and Client Secret issued from the Admin API configuration (OAuth application in Quip)
  • API access token and refresh token generated with ADMIN_READ and USER_READ privileges
  • The account used for API access must be added to the Admin API Users list in Quip, with the required admin api management permission (hidden by default)
  • Customer Quip company ID (visible in the Quip admin console)
  • Quip instance hostname (e.g., glean.quip.com)
  • Personal access tokens created via quip.com/dev/token are not acceptable
  • It is strongly advised to create and use a dedicated Quip service account for Glean integration

​
Preliminary Source/System Setup

  • Enable Quip Admin API for your organization by submitting a request to Salesforce/Quip support
  • Optionally, ask Quip support to raise the per-user API rate limit (default is 100 requests/min; request up to 500)
  • Create an OAuth application in Quip named “Glean” with ADMIN_READ and USER_READ privileges to obtain client credentials
  • Use the Quip admin console to retrieve the company ID and verify the instance hostname
  • Add the designated integration user to the Admin API Users list and assign the required permissions
  • Optional: Enable and license the Quip Events API add-on from Salesforce for activity/event ingestion

​
Configuration and Setup Instructions

Setting up Glean’s Quip connector involves steps in both Quip and Glean admin interfaces, focusing on OAuth app creation, credential management, and config validation.

​
Prerequisites

  • Admin access to the Quip instance
  • Glean Admin privileges to configure datasources
  • Confirmed availability of required API privileges and client credentials

​
Ensure the Quip Admin API is enabled on your Quip instance

  1. This may require contacting Quip support for enablement.
  2. Ideally we also request Quip Support to raise the per-user rate limit for the Admin API to 500 requests per minute. The default is 100 requests per minute which is quite low.
  3. Admins can verify access to the Admin API by manually invoking the /users/list endpoint.

​
Add Quip configs

  1. Find your company’s company ID. As an admin, navigate to Admin Console > Settings > Site Settings > Site Profile. Enter the company ID into the corresponding input box.
  2. Enter your company’s Quip instance name to the corresponding input box. For example, if you access quip at acme.quip.com, then the instance name is acme.

​
Generate a Quip API Key

  1. As an admin, navigate to Admin Console > Settings > Integrations > New API Key. Enable the ADMIN_READ and USER_READ scopes only.
  2. Enter the API key Client ID and Client Secret into their corresponding input boxes.
  3. Click Authorize in Glean and follow the generated link. If the authorization succeeds, you’re all set!
Visit the Quip Documentation for more information.