The Quip API provides read/write access to Quip, enabling you to automate processes and integrate Quip with other products you or your company uses.
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Returns the given thread.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
id | String | Thread id. |
Returns the given threads.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
ids | List | Thread id list. |
Returns the given thread.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
Creates a document, returning the new thread in the format
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
content | String | The HTML or Markdown content of the new document |
title | String | The title of the new document. If not specified, we infer the title from the first content of the document, e.g., the first heading. |
format | Select | Either html or markdown. |
memberIds | List | List of folder IDs or user IDs. The document will be placed in the specified folders, and any individual users listed will be granted individual access to the document. If this argument is not given, the document is created in the authenticated user’s Private folder. |
Creates a spreadsheet, returning the new thread in the format
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
content | String | The HTML or Markdown content of the new document |
title | String | The title of the new document. If not specified, we infer the title from the first content of the document, e.g., the first heading. |
format | Select | Either html or markdown. |
memberIds | List | List of folder IDs or user IDs. The document will be placed in the specified folders, and any individual users listed will be granted individual access to the document. If this argument is not given, the document is created in the authenticated user’s Private folder. |
Incrementally modifies the content of a document.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
content | String | The HTML or Markdown content of the new document |
format | Select | Either html or markdown. |
sectionId | String | The id for the section you want to modify. Needed for some location values. |
location | Select | Where we should insert the new content. Must be: 0,1,2,3,4,5 |
location:
0: APPEND - Append to the end of the document.
1: PREPEND - Prepend to the beginning of the document.
2: AFTER_SECTION - Insert after the section specified by section_id.
3: BEFORE_SECTION - Insert before the section specified by section_id.
4: REPLACE_SECTION - Delete the section specified by section_id and insert the new content at that location.
5: DELETE_SECTION - Delete the section specified by section_id (no content required).
Shares the given thread with the given user IDs and/or adds the given thread to the given folder IDs.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
memberIds | List | List of folder IDs or user IDs. |
Removes the given individuals from the given thread and/or removes the thread from the given folders.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
memberIds | List | List of folder IDs or user IDs. |
Retrieves the binary representation of the given blob from the given thread if the user has access.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
blobId | String | Blob id |
Uploads an image or other blob to the given thread.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
blob | File | Image file. |
name | String | File name |
Returns a list of the most recent messages for the given thread, ordered reverse-chronologically.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
count | Number | The number of messages to return. |
maxCreatedUsec | Number | If given, we return messages updated before the given max_created_usec, which is a UNIX timestamp in microseconds. |
Adds a chat message to the given thread, posted as the authenticated user.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
threadId | String | The thread whose document you want to modify |
frame | Select | One of bubble, card, or line |
content | String | Plain text content of the new message (ignored if parts is supplied) |
Returns the given folders.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
folderId | String | Single folder id |
Return data for each of the given folders in a dictionary by folder ID.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
foldersId | List | List of folder id`s |
Creates a folder.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
title | String | The name of the folder |
parentId | String | If given, we make the folder a child of the given folder. If not given, we create the folder on the authenticated user’s Private folder. |
color | String | One of the color constants above. Example: manila |
memberIds | List | List of folder IDs or user IDs. |
Updates a folder.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
folderId | String | The folder to alter |
title | String | The name of the folder |
color | String | One of the color constants above. Example: manila |
Shares the given folder with the given user IDs.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
folderId | String | The folder to which you want to add users. |
memberIds | List | List of folder IDs or user IDs. |
Shares the given folder with the given user IDs.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
folderId | String | The folder to which you want to add users. |
memberIds | List | List of folder IDs or user IDs. |
Returns the given users.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
userId | String | The user ID. |
Return data for each of the given users in a dictionary.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
usersId | List | List of user id |
Returns the currently authenticated user.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |
Returns a list of the contacts for the authenticated user.
Field | Type | Description |
---|---|---|
accessToken | credentials | Your quip OAuth2 access token |