Docs
Documents
Documents and their comments. Creating, renaming and trashing a spreadsheet happens here too, because a spreadsheet is a document.
| Method | Endpoint | Permission |
|---|---|---|
| POST |
Copy a document
/v1/documents/:id/copy
Copies a document with its contents. The copy belongs to the key's owner.
|
docs.documents.write |
| POST |
Post a comment
/v1/documents/:id/comments
Adds a comment to a document, or a reply when parent_id is set.
|
docs.comments.write |
| POST |
Create a document
/v1/documents
Creates a document or a spreadsheet. A new spreadsheet arrives with its workbook ready, so the spreadsheet endpoints work on it immediately.
|
docs.documents.write |
| DELETE |
Delete a comment
/v1/comments/:id
Removes a comment. Only its author may.
|
docs.comments.write |
| DELETE |
Delete a document
/v1/documents/:id
Moves a document to the trash, which is reversible. There is no permanent delete: retrying a failed batch cannot destroy anything.
|
docs.documents.write |
| GET |
Get a document
/v1/documents/:id
Returns a document's metadata. Its contents are read through the spreadsheet endpoints.
|
docs.documents.read |
| GET |
List comments
/v1/documents/:id/comments
Lists comment threads on a document.
|
docs.comments.read |
| GET |
List documents
/v1/documents
Lists documents and spreadsheets with cursor pagination.
|
docs.documents.read |
| POST |
Restore a document
/v1/documents/:id/restore
Takes a document back out of the trash.
|
docs.documents.write |
| PATCH |
Edit or resolve a comment
/v1/comments/:id
Changes a comment's text, or resolves and reopens the thread.
|
docs.comments.write |
| PATCH |
Update a document
/v1/documents/:id
Renames, moves or replaces a document's content.
|
docs.documents.write |