diff --git a/api/grist.yml b/api/grist.yml index ceb1956ec..e180a9abf 100644 --- a/api/grist.yml +++ b/api/grist.yml @@ -951,6 +951,19 @@ paths: responses: 200: description: Success + /docs/{docId}/tables/{tableId}/columns/{colId}: + delete: + operationId: "deleteColumn" + tags: + - columns + summary: "Delete a column of a table" + parameters: + - $ref: '#/components/parameters/docIdPathParam' + - $ref: '#/components/parameters/tableIdPathParam' + - $ref: '#/components/parameters/colIdPathParam' + responses: + 200: + description: Success /docs/{docId}/webhooks: get: @@ -2115,6 +2128,13 @@ components: description: "Same as `limit` query parameter." example: "5" required: false + colIdPathParam: + in: path + name: colId + schema: + type: string + description: The column id (without the starting `$`) as shown in the column configuration below the label + required: true tableIdPathParam: in: path name: tableId diff --git a/help/api.md b/help/api.md index c8ac18136..f3a3ab849 100644 --- a/help/api.md +++ b/help/api.md @@ -38,7 +38,7 @@ toc: <div> - <div id="redoc"><div class="sc-dvUynV fDfMfd redoc-wrap"><div class="sc-eWnToP ipTxH menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kizEQm bUGKYA"><svg class="sc-iIgjPs jIUTls search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-cKRKFl eIJtBZ search-input"/></div><div class="sc-iklJeh leCKhp scrollbar-container undefined"><ul class="sc-uxdHp bcezPY" role="menu"><li data-item-id="section/Authentication" class="sc-biJonm jycHIP"><label type="section" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Authentication" class="sc-hzUIXc ylzCN">Authentication</span></label></li><li data-item-id="tag/orgs" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="orgs" class="sc-hzUIXc ylzCN">orgs</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/orgs/operation/listOrgs" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List the orgs you have access to</span></label></li><li data-item-id="tag/orgs/operation/describeOrg" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe an org</span></label></li><li data-item-id="tag/orgs/operation/modifyOrg" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify an org</span></label></li><li data-item-id="tag/orgs/operation/listOrgAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to org</span></label></li><li data-item-id="tag/orgs/operation/modifyOrgAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to org</span></label></li><li data-item-id="tag/orgs/operation/listWorkspaces" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List workspaces and documents within an org</span></label></li></ul></li><li data-item-id="tag/workspaces" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="workspaces" class="sc-hzUIXc ylzCN">workspaces</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/workspaces/operation/createWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an empty workspace</span></label></li><li data-item-id="tag/workspaces/operation/describeWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe a workspace</span></label></li><li data-item-id="tag/workspaces/operation/modifyWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a workspace</span></label></li><li data-item-id="tag/workspaces/operation/deleteWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a workspace</span></label></li><li data-item-id="tag/workspaces/operation/listWorkspaceAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to workspace</span></label></li><li data-item-id="tag/workspaces/operation/modifyWorkspaceAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to workspace</span></label></li></ul></li><li data-item-id="tag/docs" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="docs" class="sc-hzUIXc ylzCN">docs</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/docs/operation/createDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an empty document</span></label></li><li data-item-id="tag/docs/operation/describeDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe a document</span></label></li><li data-item-id="tag/docs/operation/modifyDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify document metadata (but not its contents)</span></label></li><li data-item-id="tag/docs/operation/deleteDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a document</span></label></li><li data-item-id="tag/docs/operation/moveDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Move document to another workspace in the same org.</span></label></li><li data-item-id="tag/docs/operation/listDocAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to document</span></label></li><li data-item-id="tag/docs/operation/modifyDocAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to document</span></label></li><li data-item-id="tag/docs/operation/downloadDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of document, as an Sqlite file</span></label></li><li data-item-id="tag/docs/operation/downloadDocXlsx" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of document, as an Excel file</span></label></li><li data-item-id="tag/docs/operation/downloadDocCsv" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of table, as a CSV file</span></label></li></ul></li><li data-item-id="tag/records" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="records" class="sc-hzUIXc ylzCN">records</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/records/operation/listRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch records from a table</span></label></li><li data-item-id="tag/records/operation/addRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add records to a table</span></label></li><li data-item-id="tag/records/operation/modifyRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify records of a table</span></label></li><li data-item-id="tag/records/operation/replaceRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="put" class="sc-ikXwFM ecAtVr operation-type put">put</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add or update records of a table</span></label></li></ul></li><li data-item-id="tag/tables" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="tables" class="sc-hzUIXc ylzCN">tables</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/tables/operation/listTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List tables in a document</span></label></li><li data-item-id="tag/tables/operation/addTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add tables to a document</span></label></li><li data-item-id="tag/tables/operation/modifyTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify tables of a document</span></label></li></ul></li><li data-item-id="tag/columns" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="columns" class="sc-hzUIXc ylzCN">columns</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/columns/operation/listColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List columns in a table</span></label></li><li data-item-id="tag/columns/operation/addColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add columns to a table</span></label></li><li data-item-id="tag/columns/operation/modifyColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify columns of a table</span></label></li><li data-item-id="tag/columns/operation/replaceColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="put" class="sc-ikXwFM ecAtVr operation-type put">put</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add or update columns of a table</span></label></li></ul></li><li data-item-id="tag/data" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="data" class="sc-hzUIXc ylzCN">data</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/data/operation/getTableData" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch data from a table</span></label></li><li data-item-id="tag/data/operation/addRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add rows to a table</span></label></li><li data-item-id="tag/data/operation/modifyRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify rows of a table</span></label></li><li data-item-id="tag/data/operation/deleteRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete rows of a table</span></label></li></ul></li><li data-item-id="tag/attachments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="attachments" class="sc-hzUIXc ylzCN">attachments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/attachments/operation/listAttachments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List metadata of all attachments in a doc</span></label></li><li data-item-id="tag/attachments/operation/uploadAttachments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Upload attachments to a doc</span></label></li><li data-item-id="tag/attachments/operation/getAttachmentMetadata" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get the metadata for an attachment</span></label></li><li data-item-id="tag/attachments/operation/downloadAttachment" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Download the contents of an attachment</span></label></li></ul></li><li data-item-id="tag/webhooks" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="webhooks" class="sc-hzUIXc ylzCN">webhooks</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks/get" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Webhooks associated with a document</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create new webhooks for a document</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/patch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/delete" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Remove a webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1queue/delete" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Empty a document's queue of undelivered payloads</span></label></li></ul></li><li data-item-id="tag/sql" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="sql" class="sc-hzUIXc ylzCN">sql</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/sql/paths/~1docs~1{docId}~1sql/get" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Run an SQL query against a document</span></label></li><li data-item-id="tag/sql/paths/~1docs~1{docId}~1sql/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Run an SQL query against a document, with options or parameters</span></label></li></ul></li></ul><div class="sc-kYPZxB bflbaj"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kTCsyW ceJzZm"><div class="sc-irKDMX eOSIAa"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d=" + <div id="redoc"><div class="sc-dvUynV fDfMfd redoc-wrap"><div class="sc-eWnToP ipTxH menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kizEQm bUGKYA"><svg class="sc-iIgjPs jIUTls search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-cKRKFl eIJtBZ search-input"/></div><div class="sc-iklJeh leCKhp scrollbar-container undefined"><ul class="sc-uxdHp bcezPY" role="menu"><li data-item-id="section/Authentication" class="sc-biJonm jycHIP"><label type="section" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Authentication" class="sc-hzUIXc ylzCN">Authentication</span></label></li><li data-item-id="tag/orgs" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="orgs" class="sc-hzUIXc ylzCN">orgs</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/orgs/operation/listOrgs" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List the orgs you have access to</span></label></li><li data-item-id="tag/orgs/operation/describeOrg" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe an org</span></label></li><li data-item-id="tag/orgs/operation/modifyOrg" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify an org</span></label></li><li data-item-id="tag/orgs/operation/listOrgAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to org</span></label></li><li data-item-id="tag/orgs/operation/modifyOrgAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to org</span></label></li><li data-item-id="tag/orgs/operation/listWorkspaces" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List workspaces and documents within an org</span></label></li></ul></li><li data-item-id="tag/workspaces" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="workspaces" class="sc-hzUIXc ylzCN">workspaces</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/workspaces/operation/createWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an empty workspace</span></label></li><li data-item-id="tag/workspaces/operation/describeWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe a workspace</span></label></li><li data-item-id="tag/workspaces/operation/modifyWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a workspace</span></label></li><li data-item-id="tag/workspaces/operation/deleteWorkspace" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a workspace</span></label></li><li data-item-id="tag/workspaces/operation/listWorkspaceAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to workspace</span></label></li><li data-item-id="tag/workspaces/operation/modifyWorkspaceAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to workspace</span></label></li></ul></li><li data-item-id="tag/docs" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="docs" class="sc-hzUIXc ylzCN">docs</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/docs/operation/createDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an empty document</span></label></li><li data-item-id="tag/docs/operation/describeDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Describe a document</span></label></li><li data-item-id="tag/docs/operation/modifyDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify document metadata (but not its contents)</span></label></li><li data-item-id="tag/docs/operation/deleteDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a document</span></label></li><li data-item-id="tag/docs/operation/moveDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Move document to another workspace in the same org.</span></label></li><li data-item-id="tag/docs/operation/listDocAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List users with access to document</span></label></li><li data-item-id="tag/docs/operation/modifyDocAccess" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Change who has access to document</span></label></li><li data-item-id="tag/docs/operation/downloadDoc" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of document, as an Sqlite file</span></label></li><li data-item-id="tag/docs/operation/downloadDocXlsx" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of document, as an Excel file</span></label></li><li data-item-id="tag/docs/operation/downloadDocCsv" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Content of table, as a CSV file</span></label></li></ul></li><li data-item-id="tag/records" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="records" class="sc-hzUIXc ylzCN">records</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/records/operation/listRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch records from a table</span></label></li><li data-item-id="tag/records/operation/addRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add records to a table</span></label></li><li data-item-id="tag/records/operation/modifyRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify records of a table</span></label></li><li data-item-id="tag/records/operation/replaceRecords" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="put" class="sc-ikXwFM ecAtVr operation-type put">put</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add or update records of a table</span></label></li></ul></li><li data-item-id="tag/tables" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="tables" class="sc-hzUIXc ylzCN">tables</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/tables/operation/listTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List tables in a document</span></label></li><li data-item-id="tag/tables/operation/addTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add tables to a document</span></label></li><li data-item-id="tag/tables/operation/modifyTables" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify tables of a document</span></label></li></ul></li><li data-item-id="tag/columns" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="columns" class="sc-hzUIXc ylzCN">columns</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/columns/operation/listColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List columns in a table</span></label></li><li data-item-id="tag/columns/operation/addColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add columns to a table</span></label></li><li data-item-id="tag/columns/operation/modifyColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify columns of a table</span></label></li><li data-item-id="tag/columns/operation/replaceColumns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="put" class="sc-ikXwFM ecAtVr operation-type put">put</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add or update columns of a table</span></label></li><li data-item-id="tag/columns/operation/deleteColumn" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a column of a table</span></label></li></ul></li><li data-item-id="tag/data" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="data" class="sc-hzUIXc ylzCN">data</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/data/operation/getTableData" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch data from a table</span></label></li><li data-item-id="tag/data/operation/addRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Add rows to a table</span></label></li><li data-item-id="tag/data/operation/modifyRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify rows of a table</span></label></li><li data-item-id="tag/data/operation/deleteRows" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete rows of a table</span></label></li></ul></li><li data-item-id="tag/attachments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="attachments" class="sc-hzUIXc ylzCN">attachments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/attachments/operation/listAttachments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List metadata of all attachments in a doc</span></label></li><li data-item-id="tag/attachments/operation/uploadAttachments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Upload attachments to a doc</span></label></li><li data-item-id="tag/attachments/operation/getAttachmentMetadata" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get the metadata for an attachment</span></label></li><li data-item-id="tag/attachments/operation/downloadAttachment" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Download the contents of an attachment</span></label></li></ul></li><li data-item-id="tag/webhooks" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="webhooks" class="sc-hzUIXc ylzCN">webhooks</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks/get" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Webhooks associated with a document</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create new webhooks for a document</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/patch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="patch" class="sc-ikXwFM ecAtVr operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/delete" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Remove a webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1docs~1{docId}~1webhooks~1queue/delete" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Empty a document's queue of undelivered payloads</span></label></li></ul></li><li data-item-id="tag/sql" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="sql" class="sc-hzUIXc ylzCN">sql</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/sql/paths/~1docs~1{docId}~1sql/get" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Run an SQL query against a document</span></label></li><li data-item-id="tag/sql/paths/~1docs~1{docId}~1sql/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Run an SQL query against a document, with options or parameters</span></label></li></ul></li></ul><div class="sc-kYPZxB bflbaj"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kTCsyW ceJzZm"><div class="sc-irKDMX eOSIAa"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d=" m -673.67664,1221.6502 -231.2455,-231.24803 55.6165, -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894, 0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892, @@ -181,7 +181,11 @@ toc: </div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The columns to add or update. We check whether the specified column ID exists: if so, the column is updated with the provided data, otherwise a new column is created. Also note that some query parameters alter this behavior.</p> </div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="columns"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">columns</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p> -</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy bummOK gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-64" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-65" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-65" aria-labelledby="react-tabs-64"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"columns"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"pet"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Pet"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"popularity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Popularity ❤"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Int"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/data" data-section-id="tag/data" class="sc-eCApnc lpoiLM"><div class="sc-iCoGMd fStpoi"><div class="sc-hKFxyN bwFyQs"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/data" aria-label="tag/data"></a>data</h1></div></div><div class="sc-hKFxyN lksXXu"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Work with table data, using a (now deprecated) columnar format. We now recommend the <code>records</code> endpoints.</p> +</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy bummOK gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-64" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-65" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-65" aria-labelledby="react-tabs-64"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"columns"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"pet"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Pet"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"popularity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Popularity ❤"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Int"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/columns/operation/deleteColumn" data-section-id="tag/columns/operation/deleteColumn" class="sc-eCApnc khndJD"><div data-section-id="operation/deleteColumn" id="operation/deleteColumn" class="sc-iCoGMd fStpoi"><div class="sc-hKFxyN bwFyQs"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/columns/operation/deleteColumn" aria-label="tag/columns/operation/deleteColumn"></a>Delete a column of a table<!-- --> </h2><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe hyDbyC"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/docs/{docId}/tables/{tableId}/columns/{colId}</span><svg class="sc-dIsUp izTTdU" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://{subdomain}.getgrist.com/api</span>/docs/{docId}/tables/{tableId}/columns/{colId}</div></div></div></div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>API Key</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="docId"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">docId</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->DocKey<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A string id (UUID)</p> +</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="tableId"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">tableId</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>normalized table name (see <code>TABLE ID</code> in Raw Data) or numeric row ID in <code>_grist_Tables</code></p> +</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="colId"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">colId</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The column id (without the starting <code>$</code>) as shown in the column configuration below the label</p> +</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p> +</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy bummOK gcushC"></div></div></div><div id="tag/data" data-section-id="tag/data" class="sc-eCApnc lpoiLM"><div class="sc-iCoGMd fStpoi"><div class="sc-hKFxyN bwFyQs"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/data" aria-label="tag/data"></a>data</h1></div></div><div class="sc-hKFxyN lksXXu"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Work with table data, using a (now deprecated) columnar format. We now recommend the <code>records</code> endpoints.</p> </div></div></div><div id="tag/data/operation/getTableData" data-section-id="tag/data/operation/getTableData" class="sc-eCApnc khndJD"><div data-section-id="operation/getTableData" id="operation/getTableData" class="sc-iCoGMd fStpoi"><div class="sc-hKFxyN bwFyQs"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/data/operation/getTableData" aria-label="tag/data/operation/getTableData"></a>Fetch data from a table<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe hyDbyC"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/docs/{docId}/tables/{tableId}/data</span><svg class="sc-dIsUp izTTdU" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://{subdomain}.getgrist.com/api</span>/docs/{docId}/tables/{tableId}/data</div></div></div></div></div><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Deprecated in favor of <code>records</code> endpoints. We have no immediate plans to remove these endpoints, but consider <code>records</code> a better starting point for new projects.</p> </div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>API Key</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="docId"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">docId</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->DocKey<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A string id (UUID)</p> </div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="tableId"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">tableId</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>normalized table name (see <code>TABLE ID</code> in Raw Data) or numeric row ID in <code>_grist_Tables</code></p> @@ -248,7 +252,7 @@ Also note that some query parameters alter this behavior.</p> </div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The result set for the query.</p> </span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy bummOK gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-96" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-97" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-97" aria-labelledby="react-tabs-96"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"sql"</span>: <span class="token string">"select * from Pets where popularity >= ?"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">50</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeout"</span>: <span class="token number">500</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-98" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-99" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-99" aria-labelledby="react-tabs-98"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"statement"</span>: <span class="token string">"select * from Pets ..."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"records"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pet"</span>: <span class="token string">"cat"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"popularity"</span>: <span class="token number">67</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pet"</span>: <span class="token string">"dog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"popularity"</span>: <span class="token number">95</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-ellfGf HrYdq"></div></div></div> <script> - const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"info":{"description":"An API for manipulating Grist sites, workspaces, and documents.\n\n# Authentication\n<SecurityDefinitions />\n","version":"1.0.1","title":"Grist API"},"openapi":"3.0.0","security":[{"API Key":[]}],"servers":[{"url":"https://{subdomain}.getgrist.com/api","variables":{"subdomain":{"description":"The team name, or `docs` for personal areas","default":"docs"}}}],"paths":{"/orgs":{"get":{"operationId":"listOrgs","tags":["orgs"],"summary":"List the orgs you have access to","description":"This enumerates all the team sites or personal areas available.","responses":{"200":{"description":"An array of organizations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orgs"}}}}}}},"/orgs/{orgId}":{"get":{"operationId":"describeOrg","tags":["orgs"],"summary":"Describe an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"An organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}}}},"patch":{"operationId":"modifyOrg","tags":["orgs"],"summary":"Modify an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/orgs/{orgId}/access":{"get":{"operationId":"listOrgAccess","tags":["orgs"],"summary":"List users with access to org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"Users with access to org","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgAccessRead"}}}}}},"patch":{"operationId":"modifyOrgAccess","tags":["orgs"],"summary":"Change who has access to org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/OrgAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/orgs/{orgId}/workspaces":{"get":{"operationId":"listWorkspaces","tags":["orgs"],"summary":"List workspaces and documents within an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"An org's workspaces and documents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWithWorkspaces"}}}}}},"post":{"operationId":"createWorkspace","tags":["workspaces"],"summary":"Create an empty workspace","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"settings for the workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceParameters"}}},"required":true},"responses":{"200":{"description":"The workspace id","content":{"application/json":{"schema":{"type":"integer","description":"an identifier for the workspace","example":155}}}}}}},"/workspaces/{workspaceId}":{"get":{"operationId":"describeWorkspace","tags":["workspaces"],"summary":"Describe a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"A workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceWithOrg"}}}}}},"patch":{"operationId":"modifyWorkspace","tags":["workspaces"],"summary":"Modify a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}},"delete":{"operationId":"deleteWorkspace","tags":["workspaces"],"summary":"Delete a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"Success"}}}},"/workspaces/{workspaceId}/docs":{"post":{"operationId":"createDoc","tags":["docs"],"summary":"Create an empty document","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"settings for the document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocParameters"}}},"required":true},"responses":{"200":{"description":"The document id","content":{"application/json":{"schema":{"type":"string","description":"a unique identifier for the document","example":"8b97c8db-b4df-4b34-b72c-17459e70140a"}}}}}}},"/workspaces/{workspaceId}/access":{"get":{"operationId":"listWorkspaceAccess","tags":["workspaces"],"summary":"List users with access to workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"Users with access to workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAccessRead"}}}}}},"patch":{"operationId":"modifyWorkspaceAccess","tags":["workspaces"],"summary":"Change who has access to workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/WorkspaceAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}":{"get":{"operationId":"describeDoc","tags":["docs"],"summary":"Describe a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A document's metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocWithWorkspace"}}}}}},"patch":{"operationId":"modifyDoc","tags":["docs"],"summary":"Modify document metadata (but not its contents)","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}},"delete":{"operationId":"deleteDoc","tags":["docs"],"summary":"Delete a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/move":{"patch":{"operationId":"moveDoc","tags":["docs"],"summary":"Move document to another workspace in the same org.","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the target workspace","content":{"application/json":{"schema":{"type":"object","required":["workspace"],"properties":{"workspace":{"type":"integer","example":597}}}}}},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/access":{"get":{"operationId":"listDocAccess","tags":["docs"],"summary":"List users with access to document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Users with access to document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocAccessRead"}}}}}},"patch":{"operationId":"modifyDocAccess","tags":["docs"],"summary":"Change who has access to document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/DocAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/download":{"get":{"operationId":"downloadDoc","tags":["docs"],"summary":"Content of document, as an Sqlite file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"nohistory","schema":{"type":"boolean","description":"Remove document history (can significantly reduce file size)"},"required":false},{"in":"query","name":"template","schema":{"type":"boolean","description":"Remove all data and history but keep the structure to use the document as a template"},"required":false}],"responses":{"200":{"description":"A document's content in Sqlite form","content":{"application/x-sqlite3":{"schema":{"type":"string","format":"binary"}}}}}}},"/docs/{docId}/download/xlsx":{"get":{"operationId":"downloadDocXlsx","tags":["docs"],"summary":"Content of document, as an Excel file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A documents's content in Excel form","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}}}}},"/docs/{docId}/download/csv":{"get":{"operationId":"downloadDocCsv","tags":["docs"],"summary":"Content of table, as a CSV file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"tableId","schema":{"type":"string","description":"Name of a table (normalized)."},"required":true}],"responses":{"200":{"description":"A table's content in CSV form","content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/docs/{docId}/tables/{tableId}/data":{"get":{"operationId":"getTableData","tags":["data"],"summary":"Fetch data from a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"}],"responses":{"200":{"description":"Cells from the table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}}}}},"post":{"operationId":"addRows","tags":["data"],"summary":"Add rows to a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the data to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataWithoutId"}}},"required":true},"responses":{"200":{"description":"IDs of rows added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}},"patch":{"operationId":"modifyRows","tags":["data"],"summary":"Modify rows of a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the data to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}},"required":true},"responses":{"200":{"description":"IDs of rows modified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}}},"/docs/{docId}/tables/{tableId}/data/delete":{"post":{"operationId":"deleteRows","tags":["data"],"summary":"Delete rows of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the IDs of rows to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}},"required":true},"responses":{"200":{"description":"Nothing returned"}}}},"/docs/{docId}/attachments":{"get":{"operationId":"listAttachments","tags":["attachments"],"summary":"List metadata of all attachments in a doc","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"}],"responses":{"200":{"description":"List of attachment metadata records. Note that the list may temporarily include records for attachments that are stored in the document but not referenced by any Attachments type cell.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentMetadataList"}}}}}},"post":{"operationId":"uploadAttachments","tags":["attachments"],"summary":"Upload attachments to a doc","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the files to add to the doc","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AttachmentUpload"}}},"required":true},"responses":{"200":{"description":"IDs of attachments added, one per file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}}},"/docs/{docId}/attachments/{attachmentId}":{"get":{"operationId":"getAttachmentMetadata","tags":["attachments"],"summary":"Get the metadata for an attachment","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"attachmentId","schema":{"$ref":"#/components/schemas/AttachmentId"},"required":true}],"responses":{"200":{"description":"Attachment metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentMetadata"}}}}}}},"/docs/{docId}/attachments/{attachmentId}/download":{"get":{"operationId":"downloadAttachment","tags":["attachments"],"summary":"Download the contents of an attachment","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"attachmentId","schema":{"$ref":"#/components/schemas/AttachmentId"},"required":true}],"responses":{"200":{"description":"Attachment contents, with suitable Content-Type."}}}},"/docs/{docId}/tables/{tableId}/records":{"get":{"operationId":"listRecords","tags":["records"],"summary":"Fetch records from a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"},{"$ref":"#/components/parameters/hiddenQueryParam"}],"responses":{"200":{"description":"Records from the table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsList"}}}}}},"post":{"operationId":"addRecords","tags":["records"],"summary":"Add records to a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the records to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithoutId"}}},"required":true},"responses":{"200":{"description":"IDs of records added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithoutFields"}}}}}},"patch":{"operationId":"modifyRecords","tags":["records"],"summary":"Modify records of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the records to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsList"}}},"required":true},"responses":{"200":{"description":"Success"}}},"put":{"operationId":"replaceRecords","tags":["records"],"summary":"Add or update records of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"},{"in":"query","name":"onmany","schema":{"type":"string","enum":["first","none","all"],"description":"Which records to update if multiple records are found to match `require`.\n * `first` - the first matching record (default)\n * `none` - do not update anything\n * `all` - update all matches\n"}},{"in":"query","name":"noadd","schema":{"type":"boolean","description":"Set to true to prohibit adding records."}},{"in":"query","name":"noupdate","schema":{"type":"boolean","description":"Set to true to prohibit updating records."}},{"in":"query","name":"allow_empty_require","schema":{"type":"boolean","description":"Set to true to allow `require` in the body to be empty, which will match and update all records in the table."}}],"requestBody":{"description":"The records to add or update. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in `fields`. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithRequire"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/tables":{"get":{"operationId":"listTables","tags":["tables"],"summary":"List tables in a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"responses":{"200":{"description":"The tables in a document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesList"}}}}}},"post":{"operationId":"addTables","tags":["tables"],"summary":"Add tables to a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"requestBody":{"description":"the tables to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTables"}}},"required":true},"responses":{"200":{"description":"The table created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesWithoutFields"}}}}}},"patch":{"operationId":"modifyTables","tags":["tables"],"summary":"Modify tables of a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"requestBody":{"description":"the tables to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesList"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/tables/{tableId}/columns":{"get":{"operationId":"listColumns","tags":["columns"],"summary":"List columns in a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/hiddenQueryParam"}],"responses":{"200":{"description":"The columns in a table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColumnsList"}}}}}},"post":{"operationId":"addColumns","tags":["columns"],"summary":"Add columns to a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the columns to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateColumns"}}},"required":true},"responses":{"200":{"description":"The columns created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColumnsWithoutFields"}}}}}},"patch":{"operationId":"modifyColumns","tags":["columns"],"summary":"Modify columns of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the columns to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateColumns"}}},"required":true},"responses":{"200":{"description":"Success"}}},"put":{"operationId":"replaceColumns","tags":["columns"],"summary":"Add or update columns of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"in":"query","name":"noadd","schema":{"type":"boolean","description":"Set to true to prohibit adding columns."}},{"in":"query","name":"noupdate","schema":{"type":"boolean","description":"Set to true to prohibit updating columns."}},{"in":"query","name":"replaceall","schema":{"type":"boolean","description":"Set to true to remove existing columns (except the hidden ones) that are not specified in the request body."}}],"requestBody":{"description":"The columns to add or update. We check whether the specified column ID exists: if so, the column is updated with the provided data, otherwise a new column is created.\nAlso note that some query parameters alter this behavior.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateColumns"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/webhooks":{"get":{"tags":["webhooks"],"summary":"Webhooks associated with a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A list of webhooks.","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"object","$ref":"#/components/schemas/Webhooks"}}}}}}}},"post":{"tags":["webhooks"],"summary":"Create new webhooks for a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"an array of webhook settings","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"$ref":"#/components/schemas/WebhookPartialFields"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/WebhookId"}}}}}}}}}},"/docs/{docId}/webhooks/{webhookId}":{"patch":{"tags":["webhooks"],"summary":"Modify a webhook","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPartialFields"}}}},"responses":{"200":{"description":"Success."}}},"delete":{"tags":["webhooks"],"summary":"Remove a webhook","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","example":true}}}}}}}}},"/docs/{docId}/webhooks/queue":{"delete":{"tags":["webhooks"],"summary":"Empty a document's queue of undelivered payloads","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Success."}}}},"/docs/{docId}/sql":{"get":{"tags":["sql"],"summary":"Run an SQL query against a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"q","schema":{"type":"string","description":"The SQL query to run. This GET endpoint is a simplified version of the corresponding POST endpoint, without support for parameters or options. See the POST endpoint for details of what's allowed in the SQL query string."}}],"responses":{"200":{"description":"The result set for the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlResultSet"}}}}}},"post":{"tags":["sql"],"summary":"Run an SQL query against a document, with options or parameters","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"Query options","content":{"application/json":{"schema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL query to run. Must be a single SELECT statement, with no trailing semicolon. WITH clauses are permitted. All Grist documents are currently SQLite databases, and the SQL query is interpreted and run by SQLite, with various defensive measures. Statements that would modify the database are not supported.","example":"select * from Pets where popularity >= ?"},"args":{"type":"array","items":{"oneOf":[{"type":"number"},{"type":"string"}]},"description":"Parameters for the query.","example":[50]},"timeout":{"type":"number","description":"Timeout after which operations on the document will be interrupted. Specified in milliseconds. Defaults to 1000 (1 second). This default is controlled by an optional environment variable read by the Grist app, GRIST_SQL_TIMEOUT_MSEC. The default cannot be exceeded, only reduced.","example":500}}}}}},"responses":{"200":{"description":"The result set for the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlResultSet"}}}}}}}},"tags":[{"name":"orgs","description":"Team sites and personal spaces are called 'orgs' in the API."},{"name":"workspaces","description":"Sites can be organized into groups of documents called workspaces."},{"name":"docs","description":"Workspaces contain collections of Grist documents."},{"name":"records","description":"Tables contain collections of records (also called rows)."},{"name":"tables","description":"Documents are structured as a collection of tables."},{"name":"columns","description":"Tables are structured as a collection of columns."},{"name":"data","description":"Work with table data, using a (now deprecated) columnar format. We now recommend the `records` endpoints."},{"name":"attachments","description":"Documents may include attached files. Data records can refer to these using a column of type `Attachments`."},{"name":"webhooks","description":"Document changes can trigger requests to URLs called webhooks."}],"components":{"securitySchemes":{"API Key":{"type":"http","scheme":"bearer","bearerFormat":"Authorization: Bearer XXXXXXXXXXX","description":"Access to the Grist API is controlled by an Authorization header, which should contain the word 'Bearer', followed by a space, followed by your API key."}},"schemas":{"OrgKey":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"This can be an integer id, or a string subdomain (e.g. `gristlabs`), or `current` if the org is implied by the domain in the url"},"WorkspaceKey":{"type":"integer","description":"An integer id"},"DocKey":{"type":"string","description":"A string id (UUID)"},"Org":{"type":"object","required":["id","name","domain","owner","createdAt","updatedAt","access"],"properties":{"id":{"type":"integer","format":"int64","example":42},"name":{"type":"string","example":"Grist Labs"},"domain":{"type":"string","nullable":true,"example":"gristlabs"},"owner":{"type":"object","$ref":"#/components/schemas/User","nullable":true},"access":{"type":"string","$ref":"#/components/schemas/Access"},"createdAt":{"type":"string","example":"2019-09-13T15:42:35.000Z"},"updatedAt":{"type":"string","example":"2019-09-13T15:42:35.000Z"}}},"Orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"Webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"Webhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"},"fields":{"$ref":"#/components/schemas/WebhookFields"},"usage":{"$ref":"#/components/schemas/WebhookUsage"}}},"WebhookFields":{"allOf":[{"$ref":"#/components/schemas/WebhookPartialFields"},{"$ref":"#/components/schemas/WebhookRequiredFields"}]},"WebhookRequiredFields":{"type":"object","required":["name","memo","url","enabled","unsubscribeKey","eventTypes","isReadyColumn","tableId"],"properties":{"unsubscribeKey":{"type":"string"}}},"WebhookPartialFields":{"type":"object","properties":{"name":{"type":"string","example":"new-project-email","nullable":true},"memo":{"type":"string","example":"Send an email when a project is added","nullable":true},"url":{"type":"string","format":"uri","example":"https://example.com/webhook/123"},"enabled":{"type":"boolean"},"eventTypes":{"type":"array","items":{"type":"string"},"example":["add","update"]},"isReadyColumn":{"type":"string","nullable":true,"example":null},"tableId":{"type":"string","example":"Projects"}}},"WebhookUsage":{"type":"object","nullable":true,"required":["numWaiting","status"],"properties":{"numWaiting":{"type":"integer"},"status":{"type":"string","example":"idle"},"updatedTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastSuccessTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastFailureTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastErrorMessage":{"type":"string","nullable":true,"example":null},"lastHttpStatus":{"type":"number","nullable":true,"example":200},"lastEventBatch":{"$ref":"#/components/schemas/WebhookBatchStatus"}}},"WebhookBatchStatus":{"type":"object","nullable":true,"required":["size","attempts","status"],"properties":{"size":{"type":"number","example":1},"attempts":{"type":"number","example":1},"errorMessage":{"type":"string","nullable":true,"example":null},"httpStatus":{"type":"number","example":200},"status":{"type":"string","example":"success"}}},"WebhookId":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook identifier","example":"xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"}}},"WebhookRequiredProperties":{"type":"object","required":["size"],"properties":{"size":{"type":"number","example":1}}},"WebhookProperties":{"size":{"type":"number","example":1},"attempts":{"type":"number","example":1},"errorMessage":{"type":"string","nullable":true,"example":null},"httpStatus":{"type":"number","example":200},"status":{"type":"string","example":"success"}},"Workspace":{"type":"object","required":["id","name","access"],"properties":{"id":{"type":"integer","format":"int64","example":97},"name":{"type":"string","example":"Secret Plans"},"access":{"type":"string","$ref":"#/components/schemas/Access"}}},"Doc":{"type":"object","required":["id","name","isPinned","urlId","access"],"properties":{"id":{"type":"string","example":145},"name":{"type":"string","example":"Project Lollipop"},"access":{"type":"string","$ref":"#/components/schemas/Access"},"isPinned":{"type":"boolean","example":true},"urlId":{"type":"string","nullable":true,"example":null}}},"Workspaces":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"}},"WorkspaceWithDocs":{"allOf":[{"$ref":"#/components/schemas/Workspace"},{"type":"object","required":["docs"],"properties":{"docs":{"type":"array","items":{"$ref":"#/components/schemas/Doc"}}}}]},"WorkspaceWithOrg":{"allOf":[{"$ref":"#/components/schemas/Workspace"},{"type":"object","required":["org"],"properties":{"org":{"$ref":"#/components/schemas/Org"}}}]},"OrgWithWorkspaces":{"allOf":[{"$ref":"#/components/schemas/Org"},{"type":"object","required":["workspaces"],"properties":{"workspaces":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceWithDocs"}}}}]},"DocWithWorkspace":{"allOf":[{"$ref":"#/components/schemas/Doc"},{"type":"object","required":["workspace"],"properties":{"workspace":{"$ref":"#/components/schemas/WorkspaceWithOrg"}}}]},"User":{"type":"object","required":["id","name","picture"],"properties":{"id":{"type":"integer","format":"int64","example":101},"name":{"type":"string","example":"Helga Hufflepuff"},"picture":{"type":"string","nullable":true,"example":null}}},"Access":{"type":"string","enum":["owners","editors","viewers"]},"Data":{"type":"object","required":["id"],"properties":{"id":{"type":"array","items":{"type":"integer"}}},"additionalProperties":{"type":"array","items":{"type":"object"}},"example":{"id":[1,2],"pet":["cat","dog"],"popularity":[67,95]}},"DataWithoutId":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}},"example":{"pet":["cat","dog"],"popularity":[67,95]}},"RecordsList":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"number","example":1},"fields":{"type":"object","description":"A JSON object mapping column names to [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues)."}}}}},"example":{"records":[{"id":1,"fields":{"pet":"cat","popularity":67}},{"id":2,"fields":{"pet":"dog","popularity":95}}]}},"RecordsWithoutId":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"type":"object","description":"A JSON object mapping column names to [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues)."}}}}},"example":{"records":[{"fields":{"pet":"cat","popularity":67}},{"fields":{"pet":"dog","popularity":95}}]}},"RecordsWithoutFields":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"number","example":1}}}}},"example":{"records":[{"id":1},{"id":2}]}},"RecordsWithRequire":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["require"],"properties":{"require":{"type":"object","description":"keys are column identifiers, and values are [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues) we want to have in those columns (either by matching with an existing record, or creating a new record)\n"},"fields":{"type":"object","description":"keys are column identifiers, and values are [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues) to place in those columns (either overwriting values in an existing record, or in a new record)\n"}}}}},"example":{"records":[{"require":{"pet":"cat"},"fields":{"popularity":67}},{"require":{"pet":"dog"},"fields":{"popularity":95}}]}},"TablesList":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","example":"Table1"},"fields":{"type":"object"}}}}},"example":{"tables":[{"id":"People","fields":{"tableRef":1,"onDemand":true}},{"id":"Places","fields":{"tableRef":2,"onDemand":false}}]}},"TablesWithoutFields":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"Table1"}}}}},"example":{"tables":[{"id":"People"},{"id":"Places"}]}},"CreateTables":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["columns"],"properties":{"id":{"type":"string","example":"Table1"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ColumnName"},"fields":{"type":"object"}}}}}}}},"example":{"tables":[{"id":"People","columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤"}}]}]}},"ColumnsList":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ColumnName"},"fields":{"$ref":"#/components/schemas/GetFields"}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}}]}},"CreateColumns":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Column identifier"},"fields":{"$ref":"#/components/schemas/CreateFields"}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}},{"id":"Order","fields":{"type":"Ref:Orders","visibleCol":2}},{"id":"Formula","fields":{"type":"Int","formula":"$A + $B","isFormula":true}},{"id":"Status","fields":{"type":"Choice","widgetOptions":"{\"choices\":[\"New\",\"Old\"],\"choiceOptions\":{\"New\":{\"fillColor\":\"#FF0000\",\"textColor\":\"#FFFFFF\"}}}"}}]}},"UpdateColumns":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","description":"Column identifier"},"fields":{"allOf":[{"$ref":"#/components/schemas/CreateFields"},{"type":"object","properties":{"colId":{"type":"string","description":"Set it to the new column ID when you want to change it."}}}]}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}}]}},"ColumnsWithoutFields":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"ColumnName"}}}}},"example":{"columns":[{"id":"pet"},{"id":"popularity"}]}},"Fields":{"type":"object","properties":{"type":{"type":"string","description":"Column type, by default Any. Ref, RefList and DateTime types requires a postfix, e.g. <code>DateTime:America/New_York</code>, <code>Ref:Users</code>","enum":["Any","Text","Numeric","Int","Bool","Date","DateTime:<timezone>","Choice","ChoiceList","Ref:<tableId>","RefList:<tableId>","Attachments"]},"label":{"type":"string","description":"Column label."},"formula":{"type":"string","description":"A python formula, e.g.: <code>$A + Table1.lookupOne(B=$B)</code>"},"isFormula":{"type":"boolean","description":"Use \"true\" to indicate that the column is a formula column. Use \"false\" for trigger formula column."},"widgetOptions":{"type":"string","description":"A JSON object with widget options, e.g.: <code>{\"choices\": [\"cat\", \"dog\"], \"alignment\": \"right\"}</code>"},"untieColIdFromLabel":{"type":"boolean","description":"Use \"true\" to indicate that the column label should not be used as the column identifier. Use \"false\" to use the label as the identifier."},"recalcWhen":{"type":"integer","description":"A number indicating when the column should be recalculated. <ol start='0'><li>On new records or when any field in recalcDeps changes, it's a 'data-cleaning'.</li><li>Never.</li><li>Calculate on new records and on manual updates to any data field.</li></ol>"},"visibleCol":{"type":"integer","description":"For Ref and RefList columns, the colRef of a column to display"}}},"CreateFields":{"allOf":[{"$ref":"#/components/schemas/Fields"},{"type":"object","properties":{"recalcDeps":{"type":"string","description":"An encoded array of column identifiers (colRefs) that this column depends on. If any of these columns change, the column will be recalculated. E.g.: <code>[2, 3]</code>"}}}]},"GetFields":{"allOf":[{"$ref":"#/components/schemas/Fields"},{"type":"object","properties":{"recalcDeps":{"type":"array","items":{"type":"integer"},"description":"An array of column identifiers (colRefs) that this column depends on, prefixed with \"L\" constant. If any of these columns change, the column will be recalculated. E.g.: <code>[\"L\", 2, 3]</code>"},"colRef":{"type":"integer","description":"Column reference, e.g.: <code>2</code>"}}}]},"RowIds":{"type":"array","example":[101,102,103],"items":{"type":"integer"}},"DocParameters":{"type":"object","properties":{"name":{"type":"string","example":"Competitive Analysis"},"isPinned":{"type":"boolean","example":false}}},"WorkspaceParameters":{"type":"object","properties":{"name":{"type":"string","example":"Retreat Docs"}}},"OrgParameters":{"type":"object","properties":{"name":{"type":"string","example":"ACME Unlimited"}}},"OrgAccessRead":{"type":"object","required":["users"],"properties":{"users":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Andrea"},"email":{"type":"string","example":"andrea@getgrist.com"},"access":{"$ref":"#/components/schemas/Access"}}}}}},"OrgAccessWrite":{"type":"object","required":["users"],"properties":{"users":{"type":"object","additionalProperties":{"type":"string","enum":["owners","editors","viewers","members",null]},"example":{"foo@getgrist.com":"owners","bar@getgrist.com":null}}}},"WorkspaceAccessRead":{"type":"object","required":["maxInheritedRole","users"],"properties":{"maxInheritedRole":{"$ref":"#/components/schemas/Access"},"users":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Andrea"},"email":{"type":"string","example":"andrea@getgrist.com"},"access":{"$ref":"#/components/schemas/Access"},"parentAccess":{"$ref":"#/components/schemas/Access"}}}}}},"WorkspaceAccessWrite":{"type":"object","properties":{"maxInheritedRole":{"$ref":"#/components/schemas/Access"},"users":{"type":"object","additionalProperties":{"type":"string","enum":["owners","editors","viewers","members",null]},"example":{"foo@getgrist.com":"owners","bar@getgrist.com":null}}}},"DocAccessWrite":{"$ref":"#/components/schemas/WorkspaceAccessWrite"},"DocAccessRead":{"$ref":"#/components/schemas/WorkspaceAccessRead"},"AttachmentUpload":{"type":"object","properties":{"upload":{"type":"array","items":{"type":"string","format":"binary"}}}},"AttachmentId":{"type":"number","description":"An integer ID"},"AttachmentMetadata":{"type":"object","properties":{"fileName":{"type":"string","example":"logo.png"},"fileSize":{"type":"number","example":12345},"timeUploaded":{"type":"string","example":"2020-02-13T12:17:19.000Z"}}},"AttachmentMetadataList":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"number","example":1},"fields":{"$ref":"#/components/schemas/AttachmentMetadata"}}}}}},"SqlResultSet":{"type":"object","required":["statement","records"],"properties":{"statement":{"type":"string","description":"A copy of the SQL statement.","example":"select * from Pets ..."},"records":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"type":"object"}}},"example":[{"fields":{"id":1,"pet":"cat","popularity":67}},{"fields":{"id":2,"pet":"dog","popularity":95}}]}}}},"parameters":{"filterQueryParam":{"in":"query","name":"filter","schema":{"type":"string","description":"This is a JSON object mapping column names to arrays of allowed values. For example, to filter column `pet` for values `cat` and `dog`, the filter would be `{\"pet\": [\"cat\", \"dog\"]}`. JSON contains characters that are not safe to place in a URL, so it is important to url-encode them. For this example, the url-encoding is `%7B%22pet%22%3A%20%5B%22cat%22%2C%20%22dog%22%5D%7D`. See https://rosettacode.org/wiki/URL_encoding for how to url-encode a string, or https://www.urlencoder.org/ to try some examples. Multiple columns can be filtered. For example the filter for `pet` being either `cat` or `dog`, AND `size` being either `tiny` or `outrageously small`, would be `{\"pet\": [\"cat\", \"dog\"], \"size\": [\"tiny\", \"outrageously small\"]}`.","example":"{\"pet\": [\"cat\", \"dog\"]}"},"required":false},"sortQueryParam":{"in":"query","name":"sort","schema":{"type":"string","description":"Order in which to return results. If a single column name is given (e.g. `pet`), results are placed in ascending order of values in that column. To get results in an order that was previously prepared manually in Grist, use the special `manualSort` column name. Multiple columns can be specified, separated by commas (e.g. `pet,age`). For descending order, prefix a column name with a `-` character (e.g. `pet,-age`). To include additional sorting options append them after a colon (e.g. `pet,-age:naturalSort;emptyFirst,owner`). Available options are: `choiceOrder`, `naturalSort`, `emptyFirst`. Without the `sort` parameter, the order of results is unspecified.","example":"pet,-age"},"required":false},"limitQueryParam":{"in":"query","name":"limit","schema":{"type":"number","description":"Return at most this number of rows. A value of 0 is equivalent to having no limit.","example":"5"},"required":false},"sortHeaderParam":{"in":"header","name":"X-Sort","schema":{"type":"string","description":"Same as `sort` query parameter.","example":"pet,-age"},"required":false},"limitHeaderParam":{"in":"header","name":"X-Limit","schema":{"type":"number","description":"Same as `limit` query parameter.","example":"5"},"required":false},"tableIdPathParam":{"in":"path","name":"tableId","schema":{"type":"string","description":"normalized table name (see `TABLE ID` in Raw Data) or numeric row ID in `_grist_Tables`"},"required":true},"docIdPathParam":{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},"noparseQueryParam":{"in":"query","name":"noparse","schema":{"type":"boolean","description":"Set to true to prohibit parsing strings according to the column type."}},"hiddenQueryParam":{"in":"query","name":"hidden","schema":{"type":"boolean","description":"Set to true to include the hidden columns (like \"manualSort\")"}}}}}},"searchIndex":{"store":["section/Authentication","tag/orgs","tag/orgs/operation/listOrgs","tag/orgs/operation/describeOrg","tag/orgs/operation/modifyOrg","tag/orgs/operation/listOrgAccess","tag/orgs/operation/modifyOrgAccess","tag/orgs/operation/listWorkspaces","tag/workspaces","tag/workspaces/operation/createWorkspace","tag/workspaces/operation/describeWorkspace","tag/workspaces/operation/modifyWorkspace","tag/workspaces/operation/deleteWorkspace","tag/workspaces/operation/listWorkspaceAccess","tag/workspaces/operation/modifyWorkspaceAccess","tag/docs","tag/docs/operation/createDoc","tag/docs/operation/describeDoc","tag/docs/operation/modifyDoc","tag/docs/operation/deleteDoc","tag/docs/operation/moveDoc","tag/docs/operation/listDocAccess","tag/docs/operation/modifyDocAccess","tag/docs/operation/downloadDoc","tag/docs/operation/downloadDocXlsx","tag/docs/operation/downloadDocCsv","tag/records","tag/records/operation/listRecords","tag/records/operation/addRecords","tag/records/operation/modifyRecords","tag/records/operation/replaceRecords","tag/tables","tag/tables/operation/listTables","tag/tables/operation/addTables","tag/tables/operation/modifyTables","tag/columns","tag/columns/operation/listColumns","tag/columns/operation/addColumns","tag/columns/operation/modifyColumns","tag/columns/operation/replaceColumns","tag/data","tag/data/operation/getTableData","tag/data/operation/addRows","tag/data/operation/modifyRows","tag/data/operation/deleteRows","tag/attachments","tag/attachments/operation/listAttachments","tag/attachments/operation/uploadAttachments","tag/attachments/operation/getAttachmentMetadata","tag/attachments/operation/downloadAttachment","tag/webhooks","tag/webhooks/paths/~1docs~1{docId}~1webhooks/get","tag/webhooks/paths/~1docs~1{docId}~1webhooks/post","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/patch","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/delete","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1queue/delete","tag/sql","tag/sql/paths/~1docs~1{docId}~1sql/get","tag/sql/paths/~1docs~1{docId}~1sql/post"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,5.028]],["description/0",[1,4.159,2,4.159]],["title/1",[3,2.375]],["description/1",[3,1.071,4,1.953,5,1.746,6,1.953,7,2.267,8,1.592,9,2.267]],["title/2",[3,1.71,10,1.917,11,2.04]],["description/2",[3,1.071,4,1.953,5,1.746,6,1.953,12,2.267,13,2.267,14,2.267]],["title/3",[3,1.988,15,3.242]],["description/3",[16,4.301]],["title/4",[3,1.988,17,2.23]],["description/4",[16,4.301]],["title/5",[3,1.5,10,1.682,11,1.789,18,2.445]],["description/5",[19,4.301]],["title/6",[3,1.71,11,2.04,20,2.541]],["description/6",[19,4.301]],["title/7",[3,1.336,10,1.498,21,1.266,22,0.752,23,2.827]],["description/7",[24,4.301]],["title/8",[21,2.252]],["description/8",[5,1.921,8,1.751,21,1.117,22,0.663,25,2.494,26,2.494]],["title/9",[21,1.621,27,2.788,28,2.788]],["description/9",[24,4.301]],["title/10",[15,3.242,21,1.885]],["description/10",[29,3.845]],["title/11",[17,2.23,21,1.885]],["description/11",[29,3.845]],["title/12",[21,1.885,30,3.242]],["description/12",[29,3.845]],["title/13",[10,1.682,11,1.789,18,2.445,21,1.421]],["description/13",[31,4.301]],["title/14",[11,2.04,20,2.541,21,1.621]],["description/14",[31,4.301]],["title/15",[32,3.873]],["description/15",[21,1.241,22,0.737,33,2.387,34,1.946,35,2.771]],["title/16",[22,0.962,27,2.788,28,2.788]],["description/16",[36,4.992]],["title/17",[15,3.242,22,1.119]],["description/17",[37,3.845]],["title/18",[17,1.682,22,0.844,38,2.445,39,2.056]],["description/18",[37,3.845]],["title/19",[22,1.119,30,3.242]],["description/19",[37,3.845]],["title/20",[3,1.204,21,1.141,22,0.677,40,2.548,41,2.548,42,2.548]],["description/20",[43,4.992]],["title/21",[10,1.682,11,1.789,18,2.445,22,0.844]],["description/21",[44,4.301]],["title/22",[11,2.04,20,2.541,22,0.962]],["description/22",[44,4.301]],["title/23",[22,0.844,39,2.056,45,3.174,46,2.229]],["description/23",[47,4.992]],["title/24",[22,0.844,39,2.056,46,2.229,48,3.174]],["description/24",[49,4.992]],["title/25",[39,2.056,46,2.229,50,0.883,51,3.174]],["description/25",[52,4.992]],["title/26",[53,2.252]],["description/26",[8,1.751,33,2.148,34,1.751,50,0.694,53,1.117,54,1.751]],["title/27",[50,1.007,53,1.621,55,3.118]],["description/27",[56,3.505]],["title/28",[50,1.007,53,1.621,57,2.18]],["description/28",[56,3.505]],["title/29",[17,1.917,50,1.007,53,1.621]],["description/29",[56,3.505]],["title/30",[50,0.883,53,1.421,57,1.912,58,2.735]],["description/30",[56,3.505]],["title/31",[50,1.399]],["description/31",[22,0.829,34,2.189,50,0.867,59,2.686]],["title/32",[10,1.917,22,0.962,50,1.007]],["description/32",[60,3.845]],["title/33",[22,0.962,50,1.007,57,2.18]],["description/33",[60,3.845]],["title/34",[17,1.917,22,0.962,50,1.007]],["description/34",[60,3.845]],["title/35",[61,2.834]],["description/35",[34,2.189,50,0.867,59,2.686,61,1.757]],["title/36",[10,1.917,50,1.007,61,2.04]],["description/36",[62,3.505]],["title/37",[50,1.007,57,2.18,61,2.04]],["description/37",[62,3.505]],["title/38",[17,1.917,50,1.007,61,2.04]],["description/38",[62,3.505]],["title/39",[50,0.883,57,1.912,58,2.735,61,1.789]],["description/39",[62,3.505]],["title/40",[63,3.53]],["description/40",[50,0.433,53,0.698,63,1.094,64,1.558,65,1.342,66,2.614,67,1.094,68,1.558,69,1.558,70,1.558,71,1.094]],["title/41",[50,1.007,55,3.118,63,2.541]],["description/41",[53,0.968,67,0.875,71,1.517,72,0.96,73,0.96,74,0.96,75,0.875,76,0.96,77,0.96,78,0.96,79,0.96,80,0.875,81,0.96,82,0.96]],["title/42",[50,1.007,54,2.541,57,2.18]],["description/42",[53,0.968,67,0.875,71,1.517,72,0.96,73,0.96,74,0.96,75,0.875,76,0.96,77,0.96,78,0.96,79,0.96,80,0.875,81,0.96,82,0.96]],["title/43",[17,1.917,50,1.007,54,2.541]],["description/43",[53,0.968,67,0.875,71,1.517,72,0.96,73,0.96,74,0.96,75,0.875,76,0.96,77,0.96,78,0.96,79,0.96,80,0.875,81,0.96,82,0.96]],["title/44",[30,2.788,50,1.007,54,2.541]],["description/44",[83,4.992]],["title/45",[84,3.029]],["description/45",[22,0.442,46,1.167,53,0.744,61,0.937,63,1.167,65,1.432,84,1.662,85,1.662,86,1.662,87,1.662]],["title/46",[10,1.682,32,2.445,38,2.445,84,1.912]],["description/46",[88,4.301]],["title/47",[32,2.788,84,2.18,89,3.619]],["description/47",[88,4.301]],["title/48",[38,3.242,84,2.536]],["description/48",[90,4.992]],["title/49",[39,2.344,84,2.18,91,3.619]],["description/49",[92,4.992]],["title/50",[93,3.029]],["description/50",[8,1.592,20,1.592,22,0.603,93,1.366,94,2.267,95,2.267,96,2.267]],["title/51",[22,0.962,93,2.18,97,3.619]],["description/51",[98,4.301]],["title/52",[22,0.844,27,2.445,80,2.229,93,1.912]],["description/52",[98,4.301]],["title/53",[17,2.23,93,2.536]],["description/53",[99,4.301]],["title/54",[75,2.955,93,2.536]],["description/54",[99,4.301]],["title/55",[28,2.177,100,2.827,101,2.827,102,2.827,103,2.827]],["description/55",[104,4.992]],["title/56",[105,3.873]],["description/56",[]],["title/57",[22,0.752,105,2.177,106,2.435,107,2.435,108,2.435]],["description/57",[109,4.301]],["title/58",[22,0.617,105,1.786,106,1.998,107,1.998,108,1.998,110,2.319,111,2.319]],["description/58",[109,4.301]]],"invertedIndex":[["",{"_index":2,"title":{},"description":{"0":{}}}],["access",{"_index":11,"title":{"2":{},"5":{},"6":{},"13":{},"14":{},"21":{},"22":{}},"description":{}}],["add",{"_index":57,"title":{"28":{},"30":{},"33":{},"37":{},"39":{},"42":{}},"description":{}}],["against",{"_index":108,"title":{"57":{},"58":{}},"description":{}}],["anoth",{"_index":41,"title":{"20":{}},"description":{}}],["api",{"_index":9,"title":{},"description":{"1":{}}}],["area",{"_index":13,"title":{},"description":{"2":{}}}],["associ",{"_index":97,"title":{"51":{}},"description":{}}],["attach",{"_index":84,"title":{"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"45":{}}}],["authent",{"_index":0,"title":{"0":{}},"description":{}}],["avail",{"_index":14,"title":{},"description":{"2":{}}}],["better",{"_index":77,"title":{},"description":{"41":{},"42":{},"43":{}}}],["call",{"_index":8,"title":{},"description":{"1":{},"8":{},"26":{},"50":{}}}],["chang",{"_index":20,"title":{"6":{},"14":{},"22":{}},"description":{"50":{}}}],["collect",{"_index":34,"title":{},"description":{"15":{},"26":{},"31":{},"35":{}}}],["column",{"_index":61,"title":{"35":{},"36":{},"37":{},"38":{},"39":{}},"description":{"35":{},"45":{}}}],["columnar",{"_index":68,"title":{},"description":{"40":{}}}],["consid",{"_index":76,"title":{},"description":{"41":{},"42":{},"43":{}}}],["contain",{"_index":33,"title":{},"description":{"15":{},"26":{}}}],["content",{"_index":39,"title":{"18":{},"23":{},"24":{},"25":{},"49":{}},"description":{}}],["creat",{"_index":27,"title":{"9":{},"16":{},"52":{}},"description":{}}],["csv",{"_index":51,"title":{"25":{}},"description":{}}],["data",{"_index":63,"title":{"40":{},"41":{}},"description":{"40":{},"45":{}}}],["delet",{"_index":30,"title":{"12":{},"19":{},"44":{}},"description":{}}],["deprec",{"_index":67,"title":{},"description":{"40":{},"41":{},"42":{},"43":{}}}],["describ",{"_index":15,"title":{"3":{},"10":{},"17":{}},"description":{}}],["doc",{"_index":32,"title":{"15":{},"46":{},"47":{}},"description":{}}],["docs/{docid",{"_index":37,"title":{},"description":{"17":{},"18":{},"19":{}}}],["docs/{docid}/access",{"_index":44,"title":{},"description":{"21":{},"22":{}}}],["docs/{docid}/attach",{"_index":88,"title":{},"description":{"46":{},"47":{}}}],["docs/{docid}/attachments/{attachmentid",{"_index":90,"title":{},"description":{"48":{}}}],["docs/{docid}/attachments/{attachmentid}/download",{"_index":92,"title":{},"description":{"49":{}}}],["docs/{docid}/download",{"_index":47,"title":{},"description":{"23":{}}}],["docs/{docid}/download/csv",{"_index":52,"title":{},"description":{"25":{}}}],["docs/{docid}/download/xlsx",{"_index":49,"title":{},"description":{"24":{}}}],["docs/{docid}/mov",{"_index":43,"title":{},"description":{"20":{}}}],["docs/{docid}/sql",{"_index":109,"title":{},"description":{"57":{},"58":{}}}],["docs/{docid}/t",{"_index":60,"title":{},"description":{"32":{},"33":{},"34":{}}}],["docs/{docid}/tables/{tableid}/column",{"_index":62,"title":{},"description":{"36":{},"37":{},"38":{},"39":{}}}],["docs/{docid}/tables/{tableid}/data",{"_index":82,"title":{},"description":{"41":{},"42":{},"43":{}}}],["docs/{docid}/tables/{tableid}/data/delet",{"_index":83,"title":{},"description":{"44":{}}}],["docs/{docid}/tables/{tableid}/record",{"_index":56,"title":{},"description":{"27":{},"28":{},"29":{},"30":{}}}],["docs/{docid}/webhook",{"_index":98,"title":{},"description":{"51":{},"52":{}}}],["docs/{docid}/webhooks/queu",{"_index":104,"title":{},"description":{"55":{}}}],["docs/{docid}/webhooks/{webhookid",{"_index":99,"title":{},"description":{"53":{},"54":{}}}],["document",{"_index":22,"title":{"7":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"32":{},"33":{},"34":{},"51":{},"52":{},"57":{},"58":{}},"description":{"8":{},"15":{},"31":{},"45":{},"50":{}}}],["document'",{"_index":100,"title":{"55":{}},"description":{}}],["download",{"_index":91,"title":{"49":{}},"description":{}}],["empti",{"_index":28,"title":{"9":{},"16":{},"55":{}},"description":{}}],["endpoint",{"_index":71,"title":{},"description":{"40":{},"41":{},"42":{},"43":{}}}],["enumer",{"_index":12,"title":{},"description":{"2":{}}}],["excel",{"_index":48,"title":{"24":{}},"description":{}}],["favor",{"_index":72,"title":{},"description":{"41":{},"42":{},"43":{}}}],["fetch",{"_index":55,"title":{"27":{},"41":{}},"description":{}}],["file",{"_index":46,"title":{"23":{},"24":{},"25":{}},"description":{"45":{}}}],["format",{"_index":69,"title":{},"description":{"40":{}}}],["grist",{"_index":35,"title":{},"description":{"15":{}}}],["group",{"_index":26,"title":{},"description":{"8":{}}}],["immedi",{"_index":73,"title":{},"description":{"41":{},"42":{},"43":{}}}],["includ",{"_index":85,"title":{},"description":{"45":{}}}],["list",{"_index":10,"title":{"2":{},"5":{},"7":{},"13":{},"21":{},"32":{},"36":{},"46":{}},"description":{}}],["metadata",{"_index":38,"title":{"18":{},"46":{},"48":{}},"description":{}}],["modifi",{"_index":17,"title":{"4":{},"11":{},"18":{},"29":{},"34":{},"38":{},"43":{},"53":{}},"description":{}}],["move",{"_index":40,"title":{"20":{}},"description":{}}],["new",{"_index":80,"title":{"52":{}},"description":{"41":{},"42":{},"43":{}}}],["now",{"_index":66,"title":{},"description":{"40":{}}}],["option",{"_index":110,"title":{"58":{}},"description":{}}],["org",{"_index":3,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"20":{}},"description":{"1":{},"2":{}}}],["organ",{"_index":25,"title":{},"description":{"8":{}}}],["orgs/{orgid",{"_index":16,"title":{},"description":{"3":{},"4":{}}}],["orgs/{orgid}/access",{"_index":19,"title":{},"description":{"5":{},"6":{}}}],["orgs/{orgid}/workspac",{"_index":24,"title":{},"description":{"7":{},"9":{}}}],["paramet",{"_index":111,"title":{"58":{}},"description":{}}],["payload",{"_index":103,"title":{"55":{}},"description":{}}],["person",{"_index":6,"title":{},"description":{"1":{},"2":{}}}],["plan",{"_index":74,"title":{},"description":{"41":{},"42":{},"43":{}}}],["point",{"_index":79,"title":{},"description":{"41":{},"42":{},"43":{}}}],["project",{"_index":81,"title":{},"description":{"41":{},"42":{},"43":{}}}],["queri",{"_index":107,"title":{"57":{},"58":{}},"description":{}}],["queue",{"_index":101,"title":{"55":{}},"description":{}}],["recommend",{"_index":70,"title":{},"description":{"40":{}}}],["record",{"_index":53,"title":{"26":{},"27":{},"28":{},"29":{},"30":{}},"description":{"26":{},"40":{},"41":{},"42":{},"43":{},"45":{}}}],["refer",{"_index":86,"title":{},"description":{"45":{}}}],["remov",{"_index":75,"title":{"54":{}},"description":{"41":{},"42":{},"43":{}}}],["request",{"_index":95,"title":{},"description":{"50":{}}}],["row",{"_index":54,"title":{"42":{},"43":{},"44":{}},"description":{"26":{}}}],["run",{"_index":106,"title":{"57":{},"58":{}},"description":{}}],["same",{"_index":42,"title":{"20":{}},"description":{}}],["securitydefinit",{"_index":1,"title":{},"description":{"0":{}}}],["site",{"_index":5,"title":{},"description":{"1":{},"2":{},"8":{}}}],["space",{"_index":7,"title":{},"description":{"1":{}}}],["sql",{"_index":105,"title":{"56":{},"57":{},"58":{}},"description":{}}],["sqlite",{"_index":45,"title":{"23":{}},"description":{}}],["start",{"_index":78,"title":{},"description":{"41":{},"42":{},"43":{}}}],["structur",{"_index":59,"title":{},"description":{"31":{},"35":{}}}],["tabl",{"_index":50,"title":{"25":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"36":{},"37":{},"38":{},"39":{},"41":{},"42":{},"43":{},"44":{}},"description":{"26":{},"31":{},"35":{},"40":{}}}],["team",{"_index":4,"title":{},"description":{"1":{},"2":{}}}],["trigger",{"_index":94,"title":{},"description":{"50":{}}}],["type",{"_index":87,"title":{},"description":{"45":{}}}],["undeliv",{"_index":102,"title":{"55":{}},"description":{}}],["updat",{"_index":58,"title":{"30":{},"39":{}},"description":{}}],["upload",{"_index":89,"title":{"47":{}},"description":{}}],["url",{"_index":96,"title":{},"description":{"50":{}}}],["us",{"_index":65,"title":{},"description":{"40":{},"45":{}}}],["user",{"_index":18,"title":{"5":{},"13":{},"21":{}},"description":{}}],["webhook",{"_index":93,"title":{"50":{},"51":{},"52":{},"53":{},"54":{}},"description":{"50":{}}}],["within",{"_index":23,"title":{"7":{}},"description":{}}],["work",{"_index":64,"title":{},"description":{"40":{}}}],["workspac",{"_index":21,"title":{"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"20":{}},"description":{"8":{},"15":{}}}],["workspaces/{workspaceid",{"_index":29,"title":{},"description":{"10":{},"11":{},"12":{}}}],["workspaces/{workspaceid}/access",{"_index":31,"title":{},"description":{"13":{},"14":{}}}],["workspaces/{workspaceid}/doc",{"_index":36,"title":{},"description":{"16":{}}}]],"pipeline":[]}},"options":{"theme":{"spacing":{"sectionVertical":2},"breakpoints":{"medium":"50rem","large":"50rem"},"sidebar":{"width":"0px"}},"hideDownloadButton":true,"pathInMiddlePanel":true,"scrollYOffset":48,"jsonSampleExpandLevel":"all"}}; + const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"info":{"description":"An API for manipulating Grist sites, workspaces, and documents.\n\n# Authentication\n<SecurityDefinitions />\n","version":"1.0.1","title":"Grist API"},"openapi":"3.0.0","security":[{"API Key":[]}],"servers":[{"url":"https://{subdomain}.getgrist.com/api","variables":{"subdomain":{"description":"The team name, or `docs` for personal areas","default":"docs"}}}],"paths":{"/orgs":{"get":{"operationId":"listOrgs","tags":["orgs"],"summary":"List the orgs you have access to","description":"This enumerates all the team sites or personal areas available.","responses":{"200":{"description":"An array of organizations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orgs"}}}}}}},"/orgs/{orgId}":{"get":{"operationId":"describeOrg","tags":["orgs"],"summary":"Describe an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"An organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}}}},"patch":{"operationId":"modifyOrg","tags":["orgs"],"summary":"Modify an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/orgs/{orgId}/access":{"get":{"operationId":"listOrgAccess","tags":["orgs"],"summary":"List users with access to org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"Users with access to org","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgAccessRead"}}}}}},"patch":{"operationId":"modifyOrgAccess","tags":["orgs"],"summary":"Change who has access to org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/OrgAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/orgs/{orgId}/workspaces":{"get":{"operationId":"listWorkspaces","tags":["orgs"],"summary":"List workspaces and documents within an org","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"responses":{"200":{"description":"An org's workspaces and documents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgWithWorkspaces"}}}}}},"post":{"operationId":"createWorkspace","tags":["workspaces"],"summary":"Create an empty workspace","parameters":[{"in":"path","name":"orgId","schema":{"$ref":"#/components/schemas/OrgKey"},"required":true}],"requestBody":{"description":"settings for the workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceParameters"}}},"required":true},"responses":{"200":{"description":"The workspace id","content":{"application/json":{"schema":{"type":"integer","description":"an identifier for the workspace","example":155}}}}}}},"/workspaces/{workspaceId}":{"get":{"operationId":"describeWorkspace","tags":["workspaces"],"summary":"Describe a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"A workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceWithOrg"}}}}}},"patch":{"operationId":"modifyWorkspace","tags":["workspaces"],"summary":"Modify a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}},"delete":{"operationId":"deleteWorkspace","tags":["workspaces"],"summary":"Delete a workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"Success"}}}},"/workspaces/{workspaceId}/docs":{"post":{"operationId":"createDoc","tags":["docs"],"summary":"Create an empty document","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"settings for the document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocParameters"}}},"required":true},"responses":{"200":{"description":"The document id","content":{"application/json":{"schema":{"type":"string","description":"a unique identifier for the document","example":"8b97c8db-b4df-4b34-b72c-17459e70140a"}}}}}}},"/workspaces/{workspaceId}/access":{"get":{"operationId":"listWorkspaceAccess","tags":["workspaces"],"summary":"List users with access to workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"responses":{"200":{"description":"Users with access to workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAccessRead"}}}}}},"patch":{"operationId":"modifyWorkspaceAccess","tags":["workspaces"],"summary":"Change who has access to workspace","parameters":[{"in":"path","name":"workspaceId","schema":{"$ref":"#/components/schemas/WorkspaceKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/WorkspaceAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}":{"get":{"operationId":"describeDoc","tags":["docs"],"summary":"Describe a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A document's metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocWithWorkspace"}}}}}},"patch":{"operationId":"modifyDoc","tags":["docs"],"summary":"Modify document metadata (but not its contents)","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocParameters"}}},"required":true},"responses":{"200":{"description":"Success"}}},"delete":{"operationId":"deleteDoc","tags":["docs"],"summary":"Delete a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/move":{"patch":{"operationId":"moveDoc","tags":["docs"],"summary":"Move document to another workspace in the same org.","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the target workspace","content":{"application/json":{"schema":{"type":"object","required":["workspace"],"properties":{"workspace":{"type":"integer","example":597}}}}}},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/access":{"get":{"operationId":"listDocAccess","tags":["docs"],"summary":"List users with access to document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Users with access to document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocAccessRead"}}}}}},"patch":{"operationId":"modifyDocAccess","tags":["docs"],"summary":"Change who has access to document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"type":"object","required":["delta"],"properties":{"delta":{"$ref":"#/components/schemas/DocAccessWrite"}}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/download":{"get":{"operationId":"downloadDoc","tags":["docs"],"summary":"Content of document, as an Sqlite file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"nohistory","schema":{"type":"boolean","description":"Remove document history (can significantly reduce file size)"},"required":false},{"in":"query","name":"template","schema":{"type":"boolean","description":"Remove all data and history but keep the structure to use the document as a template"},"required":false}],"responses":{"200":{"description":"A document's content in Sqlite form","content":{"application/x-sqlite3":{"schema":{"type":"string","format":"binary"}}}}}}},"/docs/{docId}/download/xlsx":{"get":{"operationId":"downloadDocXlsx","tags":["docs"],"summary":"Content of document, as an Excel file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A documents's content in Excel form","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}}}}},"/docs/{docId}/download/csv":{"get":{"operationId":"downloadDocCsv","tags":["docs"],"summary":"Content of table, as a CSV file","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"tableId","schema":{"type":"string","description":"Name of a table (normalized)."},"required":true}],"responses":{"200":{"description":"A table's content in CSV form","content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/docs/{docId}/tables/{tableId}/data":{"get":{"operationId":"getTableData","tags":["data"],"summary":"Fetch data from a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"}],"responses":{"200":{"description":"Cells from the table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}}}}},"post":{"operationId":"addRows","tags":["data"],"summary":"Add rows to a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the data to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataWithoutId"}}},"required":true},"responses":{"200":{"description":"IDs of rows added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}},"patch":{"operationId":"modifyRows","tags":["data"],"summary":"Modify rows of a table","deprecated":true,"description":"Deprecated in favor of `records` endpoints. We have no immediate plans to remove these endpoints, but consider `records` a better starting point for new projects.","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the data to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}},"required":true},"responses":{"200":{"description":"IDs of rows modified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}}},"/docs/{docId}/tables/{tableId}/data/delete":{"post":{"operationId":"deleteRows","tags":["data"],"summary":"Delete rows of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the IDs of rows to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}},"required":true},"responses":{"200":{"description":"Nothing returned"}}}},"/docs/{docId}/attachments":{"get":{"operationId":"listAttachments","tags":["attachments"],"summary":"List metadata of all attachments in a doc","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"}],"responses":{"200":{"description":"List of attachment metadata records. Note that the list may temporarily include records for attachments that are stored in the document but not referenced by any Attachments type cell.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentMetadataList"}}}}}},"post":{"operationId":"uploadAttachments","tags":["attachments"],"summary":"Upload attachments to a doc","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"the files to add to the doc","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AttachmentUpload"}}},"required":true},"responses":{"200":{"description":"IDs of attachments added, one per file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowIds"}}}}}}},"/docs/{docId}/attachments/{attachmentId}":{"get":{"operationId":"getAttachmentMetadata","tags":["attachments"],"summary":"Get the metadata for an attachment","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"attachmentId","schema":{"$ref":"#/components/schemas/AttachmentId"},"required":true}],"responses":{"200":{"description":"Attachment metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentMetadata"}}}}}}},"/docs/{docId}/attachments/{attachmentId}/download":{"get":{"operationId":"downloadAttachment","tags":["attachments"],"summary":"Download the contents of an attachment","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"attachmentId","schema":{"$ref":"#/components/schemas/AttachmentId"},"required":true}],"responses":{"200":{"description":"Attachment contents, with suitable Content-Type."}}}},"/docs/{docId}/tables/{tableId}/records":{"get":{"operationId":"listRecords","tags":["records"],"summary":"Fetch records from a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/filterQueryParam"},{"$ref":"#/components/parameters/sortQueryParam"},{"$ref":"#/components/parameters/limitQueryParam"},{"$ref":"#/components/parameters/sortHeaderParam"},{"$ref":"#/components/parameters/limitHeaderParam"},{"$ref":"#/components/parameters/hiddenQueryParam"}],"responses":{"200":{"description":"Records from the table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsList"}}}}}},"post":{"operationId":"addRecords","tags":["records"],"summary":"Add records to a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the records to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithoutId"}}},"required":true},"responses":{"200":{"description":"IDs of records added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithoutFields"}}}}}},"patch":{"operationId":"modifyRecords","tags":["records"],"summary":"Modify records of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"}],"requestBody":{"description":"the records to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsList"}}},"required":true},"responses":{"200":{"description":"Success"}}},"put":{"operationId":"replaceRecords","tags":["records"],"summary":"Add or update records of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/noparseQueryParam"},{"in":"query","name":"onmany","schema":{"type":"string","enum":["first","none","all"],"description":"Which records to update if multiple records are found to match `require`.\n * `first` - the first matching record (default)\n * `none` - do not update anything\n * `all` - update all matches\n"}},{"in":"query","name":"noadd","schema":{"type":"boolean","description":"Set to true to prohibit adding records."}},{"in":"query","name":"noupdate","schema":{"type":"boolean","description":"Set to true to prohibit updating records."}},{"in":"query","name":"allow_empty_require","schema":{"type":"boolean","description":"Set to true to allow `require` in the body to be empty, which will match and update all records in the table."}}],"requestBody":{"description":"The records to add or update. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in `fields`. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsWithRequire"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/tables":{"get":{"operationId":"listTables","tags":["tables"],"summary":"List tables in a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"responses":{"200":{"description":"The tables in a document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesList"}}}}}},"post":{"operationId":"addTables","tags":["tables"],"summary":"Add tables to a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"requestBody":{"description":"the tables to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTables"}}},"required":true},"responses":{"200":{"description":"The table created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesWithoutFields"}}}}}},"patch":{"operationId":"modifyTables","tags":["tables"],"summary":"Modify tables of a document","parameters":[{"$ref":"#/components/parameters/docIdPathParam"}],"requestBody":{"description":"the tables to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TablesList"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/tables/{tableId}/columns":{"get":{"operationId":"listColumns","tags":["columns"],"summary":"List columns in a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/hiddenQueryParam"}],"responses":{"200":{"description":"The columns in a table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColumnsList"}}}}}},"post":{"operationId":"addColumns","tags":["columns"],"summary":"Add columns to a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the columns to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateColumns"}}},"required":true},"responses":{"200":{"description":"The columns created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColumnsWithoutFields"}}}}}},"patch":{"operationId":"modifyColumns","tags":["columns"],"summary":"Modify columns of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"}],"requestBody":{"description":"the columns to change, with ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateColumns"}}},"required":true},"responses":{"200":{"description":"Success"}}},"put":{"operationId":"replaceColumns","tags":["columns"],"summary":"Add or update columns of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"in":"query","name":"noadd","schema":{"type":"boolean","description":"Set to true to prohibit adding columns."}},{"in":"query","name":"noupdate","schema":{"type":"boolean","description":"Set to true to prohibit updating columns."}},{"in":"query","name":"replaceall","schema":{"type":"boolean","description":"Set to true to remove existing columns (except the hidden ones) that are not specified in the request body."}}],"requestBody":{"description":"The columns to add or update. We check whether the specified column ID exists: if so, the column is updated with the provided data, otherwise a new column is created.\nAlso note that some query parameters alter this behavior.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateColumns"}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/tables/{tableId}/columns/{colId}":{"delete":{"operationId":"deleteColumn","tags":["columns"],"summary":"Delete a column of a table","parameters":[{"$ref":"#/components/parameters/docIdPathParam"},{"$ref":"#/components/parameters/tableIdPathParam"},{"$ref":"#/components/parameters/colIdPathParam"}],"responses":{"200":{"description":"Success"}}}},"/docs/{docId}/webhooks":{"get":{"tags":["webhooks"],"summary":"Webhooks associated with a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"A list of webhooks.","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"object","$ref":"#/components/schemas/Webhooks"}}}}}}}},"post":{"tags":["webhooks"],"summary":"Create new webhooks for a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"an array of webhook settings","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"$ref":"#/components/schemas/WebhookPartialFields"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["webhooks"],"properties":{"webhooks":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/WebhookId"}}}}}}}}}},"/docs/{docId}/webhooks/{webhookId}":{"patch":{"tags":["webhooks"],"summary":"Modify a webhook","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"requestBody":{"description":"the changes to make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPartialFields"}}}},"responses":{"200":{"description":"Success."}}},"delete":{"tags":["webhooks"],"summary":"Remove a webhook","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","example":true}}}}}}}}},"/docs/{docId}/webhooks/queue":{"delete":{"tags":["webhooks"],"summary":"Empty a document's queue of undelivered payloads","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"responses":{"200":{"description":"Success."}}}},"/docs/{docId}/sql":{"get":{"tags":["sql"],"summary":"Run an SQL query against a document","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},{"in":"query","name":"q","schema":{"type":"string","description":"The SQL query to run. This GET endpoint is a simplified version of the corresponding POST endpoint, without support for parameters or options. See the POST endpoint for details of what's allowed in the SQL query string."}}],"responses":{"200":{"description":"The result set for the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlResultSet"}}}}}},"post":{"tags":["sql"],"summary":"Run an SQL query against a document, with options or parameters","parameters":[{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true}],"requestBody":{"description":"Query options","content":{"application/json":{"schema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL query to run. Must be a single SELECT statement, with no trailing semicolon. WITH clauses are permitted. All Grist documents are currently SQLite databases, and the SQL query is interpreted and run by SQLite, with various defensive measures. Statements that would modify the database are not supported.","example":"select * from Pets where popularity >= ?"},"args":{"type":"array","items":{"oneOf":[{"type":"number"},{"type":"string"}]},"description":"Parameters for the query.","example":[50]},"timeout":{"type":"number","description":"Timeout after which operations on the document will be interrupted. Specified in milliseconds. Defaults to 1000 (1 second). This default is controlled by an optional environment variable read by the Grist app, GRIST_SQL_TIMEOUT_MSEC. The default cannot be exceeded, only reduced.","example":500}}}}}},"responses":{"200":{"description":"The result set for the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlResultSet"}}}}}}}},"tags":[{"name":"orgs","description":"Team sites and personal spaces are called 'orgs' in the API."},{"name":"workspaces","description":"Sites can be organized into groups of documents called workspaces."},{"name":"docs","description":"Workspaces contain collections of Grist documents."},{"name":"records","description":"Tables contain collections of records (also called rows)."},{"name":"tables","description":"Documents are structured as a collection of tables."},{"name":"columns","description":"Tables are structured as a collection of columns."},{"name":"data","description":"Work with table data, using a (now deprecated) columnar format. We now recommend the `records` endpoints."},{"name":"attachments","description":"Documents may include attached files. Data records can refer to these using a column of type `Attachments`."},{"name":"webhooks","description":"Document changes can trigger requests to URLs called webhooks."}],"components":{"securitySchemes":{"API Key":{"type":"http","scheme":"bearer","bearerFormat":"Authorization: Bearer XXXXXXXXXXX","description":"Access to the Grist API is controlled by an Authorization header, which should contain the word 'Bearer', followed by a space, followed by your API key."}},"schemas":{"OrgKey":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"This can be an integer id, or a string subdomain (e.g. `gristlabs`), or `current` if the org is implied by the domain in the url"},"WorkspaceKey":{"type":"integer","description":"An integer id"},"DocKey":{"type":"string","description":"A string id (UUID)"},"Org":{"type":"object","required":["id","name","domain","owner","createdAt","updatedAt","access"],"properties":{"id":{"type":"integer","format":"int64","example":42},"name":{"type":"string","example":"Grist Labs"},"domain":{"type":"string","nullable":true,"example":"gristlabs"},"owner":{"type":"object","$ref":"#/components/schemas/User","nullable":true},"access":{"type":"string","$ref":"#/components/schemas/Access"},"createdAt":{"type":"string","example":"2019-09-13T15:42:35.000Z"},"updatedAt":{"type":"string","example":"2019-09-13T15:42:35.000Z"}}},"Orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"Webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"Webhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"},"fields":{"$ref":"#/components/schemas/WebhookFields"},"usage":{"$ref":"#/components/schemas/WebhookUsage"}}},"WebhookFields":{"allOf":[{"$ref":"#/components/schemas/WebhookPartialFields"},{"$ref":"#/components/schemas/WebhookRequiredFields"}]},"WebhookRequiredFields":{"type":"object","required":["name","memo","url","enabled","unsubscribeKey","eventTypes","isReadyColumn","tableId"],"properties":{"unsubscribeKey":{"type":"string"}}},"WebhookPartialFields":{"type":"object","properties":{"name":{"type":"string","example":"new-project-email","nullable":true},"memo":{"type":"string","example":"Send an email when a project is added","nullable":true},"url":{"type":"string","format":"uri","example":"https://example.com/webhook/123"},"enabled":{"type":"boolean"},"eventTypes":{"type":"array","items":{"type":"string"},"example":["add","update"]},"isReadyColumn":{"type":"string","nullable":true,"example":null},"tableId":{"type":"string","example":"Projects"}}},"WebhookUsage":{"type":"object","nullable":true,"required":["numWaiting","status"],"properties":{"numWaiting":{"type":"integer"},"status":{"type":"string","example":"idle"},"updatedTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastSuccessTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastFailureTime":{"type":"number","nullable":true,"format":"UNIX epoch in milliseconds","example":1685637500424},"lastErrorMessage":{"type":"string","nullable":true,"example":null},"lastHttpStatus":{"type":"number","nullable":true,"example":200},"lastEventBatch":{"$ref":"#/components/schemas/WebhookBatchStatus"}}},"WebhookBatchStatus":{"type":"object","nullable":true,"required":["size","attempts","status"],"properties":{"size":{"type":"number","example":1},"attempts":{"type":"number","example":1},"errorMessage":{"type":"string","nullable":true,"example":null},"httpStatus":{"type":"number","example":200},"status":{"type":"string","example":"success"}}},"WebhookId":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook identifier","example":"xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"}}},"WebhookRequiredProperties":{"type":"object","required":["size"],"properties":{"size":{"type":"number","example":1}}},"WebhookProperties":{"size":{"type":"number","example":1},"attempts":{"type":"number","example":1},"errorMessage":{"type":"string","nullable":true,"example":null},"httpStatus":{"type":"number","example":200},"status":{"type":"string","example":"success"}},"Workspace":{"type":"object","required":["id","name","access"],"properties":{"id":{"type":"integer","format":"int64","example":97},"name":{"type":"string","example":"Secret Plans"},"access":{"type":"string","$ref":"#/components/schemas/Access"}}},"Doc":{"type":"object","required":["id","name","isPinned","urlId","access"],"properties":{"id":{"type":"string","example":145},"name":{"type":"string","example":"Project Lollipop"},"access":{"type":"string","$ref":"#/components/schemas/Access"},"isPinned":{"type":"boolean","example":true},"urlId":{"type":"string","nullable":true,"example":null}}},"Workspaces":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"}},"WorkspaceWithDocs":{"allOf":[{"$ref":"#/components/schemas/Workspace"},{"type":"object","required":["docs"],"properties":{"docs":{"type":"array","items":{"$ref":"#/components/schemas/Doc"}}}}]},"WorkspaceWithOrg":{"allOf":[{"$ref":"#/components/schemas/Workspace"},{"type":"object","required":["org"],"properties":{"org":{"$ref":"#/components/schemas/Org"}}}]},"OrgWithWorkspaces":{"allOf":[{"$ref":"#/components/schemas/Org"},{"type":"object","required":["workspaces"],"properties":{"workspaces":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceWithDocs"}}}}]},"DocWithWorkspace":{"allOf":[{"$ref":"#/components/schemas/Doc"},{"type":"object","required":["workspace"],"properties":{"workspace":{"$ref":"#/components/schemas/WorkspaceWithOrg"}}}]},"User":{"type":"object","required":["id","name","picture"],"properties":{"id":{"type":"integer","format":"int64","example":101},"name":{"type":"string","example":"Helga Hufflepuff"},"picture":{"type":"string","nullable":true,"example":null}}},"Access":{"type":"string","enum":["owners","editors","viewers"]},"Data":{"type":"object","required":["id"],"properties":{"id":{"type":"array","items":{"type":"integer"}}},"additionalProperties":{"type":"array","items":{"type":"object"}},"example":{"id":[1,2],"pet":["cat","dog"],"popularity":[67,95]}},"DataWithoutId":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}},"example":{"pet":["cat","dog"],"popularity":[67,95]}},"RecordsList":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"number","example":1},"fields":{"type":"object","description":"A JSON object mapping column names to [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues)."}}}}},"example":{"records":[{"id":1,"fields":{"pet":"cat","popularity":67}},{"id":2,"fields":{"pet":"dog","popularity":95}}]}},"RecordsWithoutId":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"type":"object","description":"A JSON object mapping column names to [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues)."}}}}},"example":{"records":[{"fields":{"pet":"cat","popularity":67}},{"fields":{"pet":"dog","popularity":95}}]}},"RecordsWithoutFields":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"number","example":1}}}}},"example":{"records":[{"id":1},{"id":2}]}},"RecordsWithRequire":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["require"],"properties":{"require":{"type":"object","description":"keys are column identifiers, and values are [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues) we want to have in those columns (either by matching with an existing record, or creating a new record)\n"},"fields":{"type":"object","description":"keys are column identifiers, and values are [cell values](https://support.getgrist.com/code/interfaces/grist_plugin_api.rowrecord/#cellvalues) to place in those columns (either overwriting values in an existing record, or in a new record)\n"}}}}},"example":{"records":[{"require":{"pet":"cat"},"fields":{"popularity":67}},{"require":{"pet":"dog"},"fields":{"popularity":95}}]}},"TablesList":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","example":"Table1"},"fields":{"type":"object"}}}}},"example":{"tables":[{"id":"People","fields":{"tableRef":1,"onDemand":true}},{"id":"Places","fields":{"tableRef":2,"onDemand":false}}]}},"TablesWithoutFields":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"Table1"}}}}},"example":{"tables":[{"id":"People"},{"id":"Places"}]}},"CreateTables":{"type":"object","required":["tables"],"properties":{"tables":{"type":"array","items":{"type":"object","required":["columns"],"properties":{"id":{"type":"string","example":"Table1"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ColumnName"},"fields":{"type":"object"}}}}}}}},"example":{"tables":[{"id":"People","columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤"}}]}]}},"ColumnsList":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ColumnName"},"fields":{"$ref":"#/components/schemas/GetFields"}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}}]}},"CreateColumns":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Column identifier"},"fields":{"$ref":"#/components/schemas/CreateFields"}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}},{"id":"Order","fields":{"type":"Ref:Orders","visibleCol":2}},{"id":"Formula","fields":{"type":"Int","formula":"$A + $B","isFormula":true}},{"id":"Status","fields":{"type":"Choice","widgetOptions":"{\"choices\":[\"New\",\"Old\"],\"choiceOptions\":{\"New\":{\"fillColor\":\"#FF0000\",\"textColor\":\"#FFFFFF\"}}}"}}]}},"UpdateColumns":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","description":"Column identifier"},"fields":{"allOf":[{"$ref":"#/components/schemas/CreateFields"},{"type":"object","properties":{"colId":{"type":"string","description":"Set it to the new column ID when you want to change it."}}}]}}}}},"example":{"columns":[{"id":"pet","fields":{"label":"Pet"}},{"id":"popularity","fields":{"label":"Popularity ❤","type":"Int"}}]}},"ColumnsWithoutFields":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"ColumnName"}}}}},"example":{"columns":[{"id":"pet"},{"id":"popularity"}]}},"Fields":{"type":"object","properties":{"type":{"type":"string","description":"Column type, by default Any. Ref, RefList and DateTime types requires a postfix, e.g. <code>DateTime:America/New_York</code>, <code>Ref:Users</code>","enum":["Any","Text","Numeric","Int","Bool","Date","DateTime:<timezone>","Choice","ChoiceList","Ref:<tableId>","RefList:<tableId>","Attachments"]},"label":{"type":"string","description":"Column label."},"formula":{"type":"string","description":"A python formula, e.g.: <code>$A + Table1.lookupOne(B=$B)</code>"},"isFormula":{"type":"boolean","description":"Use \"true\" to indicate that the column is a formula column. Use \"false\" for trigger formula column."},"widgetOptions":{"type":"string","description":"A JSON object with widget options, e.g.: <code>{\"choices\": [\"cat\", \"dog\"], \"alignment\": \"right\"}</code>"},"untieColIdFromLabel":{"type":"boolean","description":"Use \"true\" to indicate that the column label should not be used as the column identifier. Use \"false\" to use the label as the identifier."},"recalcWhen":{"type":"integer","description":"A number indicating when the column should be recalculated. <ol start='0'><li>On new records or when any field in recalcDeps changes, it's a 'data-cleaning'.</li><li>Never.</li><li>Calculate on new records and on manual updates to any data field.</li></ol>"},"visibleCol":{"type":"integer","description":"For Ref and RefList columns, the colRef of a column to display"}}},"CreateFields":{"allOf":[{"$ref":"#/components/schemas/Fields"},{"type":"object","properties":{"recalcDeps":{"type":"string","description":"An encoded array of column identifiers (colRefs) that this column depends on. If any of these columns change, the column will be recalculated. E.g.: <code>[2, 3]</code>"}}}]},"GetFields":{"allOf":[{"$ref":"#/components/schemas/Fields"},{"type":"object","properties":{"recalcDeps":{"type":"array","items":{"type":"integer"},"description":"An array of column identifiers (colRefs) that this column depends on, prefixed with \"L\" constant. If any of these columns change, the column will be recalculated. E.g.: <code>[\"L\", 2, 3]</code>"},"colRef":{"type":"integer","description":"Column reference, e.g.: <code>2</code>"}}}]},"RowIds":{"type":"array","example":[101,102,103],"items":{"type":"integer"}},"DocParameters":{"type":"object","properties":{"name":{"type":"string","example":"Competitive Analysis"},"isPinned":{"type":"boolean","example":false}}},"WorkspaceParameters":{"type":"object","properties":{"name":{"type":"string","example":"Retreat Docs"}}},"OrgParameters":{"type":"object","properties":{"name":{"type":"string","example":"ACME Unlimited"}}},"OrgAccessRead":{"type":"object","required":["users"],"properties":{"users":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Andrea"},"email":{"type":"string","example":"andrea@getgrist.com"},"access":{"$ref":"#/components/schemas/Access"}}}}}},"OrgAccessWrite":{"type":"object","required":["users"],"properties":{"users":{"type":"object","additionalProperties":{"type":"string","enum":["owners","editors","viewers","members",null]},"example":{"foo@getgrist.com":"owners","bar@getgrist.com":null}}}},"WorkspaceAccessRead":{"type":"object","required":["maxInheritedRole","users"],"properties":{"maxInheritedRole":{"$ref":"#/components/schemas/Access"},"users":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Andrea"},"email":{"type":"string","example":"andrea@getgrist.com"},"access":{"$ref":"#/components/schemas/Access"},"parentAccess":{"$ref":"#/components/schemas/Access"}}}}}},"WorkspaceAccessWrite":{"type":"object","properties":{"maxInheritedRole":{"$ref":"#/components/schemas/Access"},"users":{"type":"object","additionalProperties":{"type":"string","enum":["owners","editors","viewers","members",null]},"example":{"foo@getgrist.com":"owners","bar@getgrist.com":null}}}},"DocAccessWrite":{"$ref":"#/components/schemas/WorkspaceAccessWrite"},"DocAccessRead":{"$ref":"#/components/schemas/WorkspaceAccessRead"},"AttachmentUpload":{"type":"object","properties":{"upload":{"type":"array","items":{"type":"string","format":"binary"}}}},"AttachmentId":{"type":"number","description":"An integer ID"},"AttachmentMetadata":{"type":"object","properties":{"fileName":{"type":"string","example":"logo.png"},"fileSize":{"type":"number","example":12345},"timeUploaded":{"type":"string","example":"2020-02-13T12:17:19.000Z"}}},"AttachmentMetadataList":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"number","example":1},"fields":{"$ref":"#/components/schemas/AttachmentMetadata"}}}}}},"SqlResultSet":{"type":"object","required":["statement","records"],"properties":{"statement":{"type":"string","description":"A copy of the SQL statement.","example":"select * from Pets ..."},"records":{"type":"array","items":{"type":"object","required":["fields"],"properties":{"fields":{"type":"object"}}},"example":[{"fields":{"id":1,"pet":"cat","popularity":67}},{"fields":{"id":2,"pet":"dog","popularity":95}}]}}}},"parameters":{"filterQueryParam":{"in":"query","name":"filter","schema":{"type":"string","description":"This is a JSON object mapping column names to arrays of allowed values. For example, to filter column `pet` for values `cat` and `dog`, the filter would be `{\"pet\": [\"cat\", \"dog\"]}`. JSON contains characters that are not safe to place in a URL, so it is important to url-encode them. For this example, the url-encoding is `%7B%22pet%22%3A%20%5B%22cat%22%2C%20%22dog%22%5D%7D`. See https://rosettacode.org/wiki/URL_encoding for how to url-encode a string, or https://www.urlencoder.org/ to try some examples. Multiple columns can be filtered. For example the filter for `pet` being either `cat` or `dog`, AND `size` being either `tiny` or `outrageously small`, would be `{\"pet\": [\"cat\", \"dog\"], \"size\": [\"tiny\", \"outrageously small\"]}`.","example":"{\"pet\": [\"cat\", \"dog\"]}"},"required":false},"sortQueryParam":{"in":"query","name":"sort","schema":{"type":"string","description":"Order in which to return results. If a single column name is given (e.g. `pet`), results are placed in ascending order of values in that column. To get results in an order that was previously prepared manually in Grist, use the special `manualSort` column name. Multiple columns can be specified, separated by commas (e.g. `pet,age`). For descending order, prefix a column name with a `-` character (e.g. `pet,-age`). To include additional sorting options append them after a colon (e.g. `pet,-age:naturalSort;emptyFirst,owner`). Available options are: `choiceOrder`, `naturalSort`, `emptyFirst`. Without the `sort` parameter, the order of results is unspecified.","example":"pet,-age"},"required":false},"limitQueryParam":{"in":"query","name":"limit","schema":{"type":"number","description":"Return at most this number of rows. A value of 0 is equivalent to having no limit.","example":"5"},"required":false},"sortHeaderParam":{"in":"header","name":"X-Sort","schema":{"type":"string","description":"Same as `sort` query parameter.","example":"pet,-age"},"required":false},"limitHeaderParam":{"in":"header","name":"X-Limit","schema":{"type":"number","description":"Same as `limit` query parameter.","example":"5"},"required":false},"colIdPathParam":{"in":"path","name":"colId","schema":{"type":"string","description":"The column id (without the starting `$`) as shown in the column configuration below the label"},"required":true},"tableIdPathParam":{"in":"path","name":"tableId","schema":{"type":"string","description":"normalized table name (see `TABLE ID` in Raw Data) or numeric row ID in `_grist_Tables`"},"required":true},"docIdPathParam":{"in":"path","name":"docId","schema":{"$ref":"#/components/schemas/DocKey"},"required":true},"noparseQueryParam":{"in":"query","name":"noparse","schema":{"type":"boolean","description":"Set to true to prohibit parsing strings according to the column type."}},"hiddenQueryParam":{"in":"query","name":"hidden","schema":{"type":"boolean","description":"Set to true to include the hidden columns (like \"manualSort\")"}}}}}},"searchIndex":{"store":["section/Authentication","tag/orgs","tag/orgs/operation/listOrgs","tag/orgs/operation/describeOrg","tag/orgs/operation/modifyOrg","tag/orgs/operation/listOrgAccess","tag/orgs/operation/modifyOrgAccess","tag/orgs/operation/listWorkspaces","tag/workspaces","tag/workspaces/operation/createWorkspace","tag/workspaces/operation/describeWorkspace","tag/workspaces/operation/modifyWorkspace","tag/workspaces/operation/deleteWorkspace","tag/workspaces/operation/listWorkspaceAccess","tag/workspaces/operation/modifyWorkspaceAccess","tag/docs","tag/docs/operation/createDoc","tag/docs/operation/describeDoc","tag/docs/operation/modifyDoc","tag/docs/operation/deleteDoc","tag/docs/operation/moveDoc","tag/docs/operation/listDocAccess","tag/docs/operation/modifyDocAccess","tag/docs/operation/downloadDoc","tag/docs/operation/downloadDocXlsx","tag/docs/operation/downloadDocCsv","tag/records","tag/records/operation/listRecords","tag/records/operation/addRecords","tag/records/operation/modifyRecords","tag/records/operation/replaceRecords","tag/tables","tag/tables/operation/listTables","tag/tables/operation/addTables","tag/tables/operation/modifyTables","tag/columns","tag/columns/operation/listColumns","tag/columns/operation/addColumns","tag/columns/operation/modifyColumns","tag/columns/operation/replaceColumns","tag/columns/operation/deleteColumn","tag/data","tag/data/operation/getTableData","tag/data/operation/addRows","tag/data/operation/modifyRows","tag/data/operation/deleteRows","tag/attachments","tag/attachments/operation/listAttachments","tag/attachments/operation/uploadAttachments","tag/attachments/operation/getAttachmentMetadata","tag/attachments/operation/downloadAttachment","tag/webhooks","tag/webhooks/paths/~1docs~1{docId}~1webhooks/get","tag/webhooks/paths/~1docs~1{docId}~1webhooks/post","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/patch","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1{webhookId}/delete","tag/webhooks/paths/~1docs~1{docId}~1webhooks~1queue/delete","tag/sql","tag/sql/paths/~1docs~1{docId}~1sql/get","tag/sql/paths/~1docs~1{docId}~1sql/post"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,5.051]],["description/0",[1,4.162,2,4.162]],["title/1",[3,2.398]],["description/1",[3,1.074,4,1.95,5,1.744,6,1.95,7,2.261,8,1.591,9,2.261]],["title/2",[3,1.727,10,1.934,11,2.057]],["description/2",[3,1.074,4,1.95,5,1.744,6,1.95,12,2.261,13,2.261,14,2.261]],["title/3",[3,2.008,15,3.261]],["description/3",[16,4.314]],["title/4",[3,2.008,17,2.249]],["description/4",[16,4.314]],["title/5",[3,1.515,10,1.696,11,1.804,18,2.46]],["description/5",[19,4.314]],["title/6",[3,1.727,11,2.057,20,2.558]],["description/6",[19,4.314]],["title/7",[3,1.349,10,1.511,21,1.279,22,0.765,23,2.841]],["description/7",[24,4.314]],["title/8",[21,2.274]],["description/8",[5,1.92,8,1.751,21,1.121,22,0.67,25,2.489,26,2.489]],["title/9",[21,1.637,27,2.805,28,2.805]],["description/9",[24,4.314]],["title/10",[15,3.261,21,1.904]],["description/10",[29,3.859]],["title/11",[17,2.249,21,1.904]],["description/11",[29,3.859]],["title/12",[21,1.904,30,2.975]],["description/12",[29,3.859]],["title/13",[10,1.696,11,1.804,18,2.46,21,1.436]],["description/13",[31,4.314]],["title/14",[11,2.057,20,2.558,21,1.637]],["description/14",[31,4.314]],["title/15",[32,3.896]],["description/15",[21,1.246,22,0.745,33,2.385,34,1.946,35,2.767]],["title/16",[22,0.979,27,2.805,28,2.805]],["description/16",[36,5.003]],["title/17",[15,3.261,22,1.138]],["description/17",[37,3.859]],["title/18",[17,1.696,22,0.859,38,2.46,39,2.071]],["description/18",[37,3.859]],["title/19",[22,1.138,30,2.975]],["description/19",[37,3.859]],["title/20",[3,1.216,21,1.153,22,0.689,40,2.56,41,2.56,42,2.56]],["description/20",[43,5.003]],["title/21",[10,1.696,11,1.804,18,2.46,22,0.859]],["description/21",[44,4.314]],["title/22",[11,2.057,20,2.558,22,0.979]],["description/22",[44,4.314]],["title/23",[22,0.859,39,2.071,45,3.19,46,2.244]],["description/23",[47,5.003]],["title/24",[22,0.859,39,2.071,46,2.244,48,3.19]],["description/24",[49,5.003]],["title/25",[39,2.071,46,2.244,50,0.859,51,3.19]],["description/25",[52,5.003]],["title/26",[53,2.274]],["description/26",[8,1.751,33,2.146,34,1.751,50,0.67,53,1.121,54,1.751]],["title/27",[50,0.979,53,1.637,55,3.135]],["description/27",[56,3.52]],["title/28",[50,0.979,53,1.637,57,2.197]],["description/28",[56,3.52]],["title/29",[17,1.934,50,0.979,53,1.637]],["description/29",[56,3.52]],["title/30",[50,0.859,53,1.436,57,1.927,58,2.75]],["description/30",[56,3.52]],["title/31",[50,1.36]],["description/31",[22,0.838,34,2.191,50,0.838,59,2.685]],["title/32",[10,1.934,22,0.979,50,0.979]],["description/32",[60,3.859]],["title/33",[22,0.979,50,0.979,57,2.197]],["description/33",[60,3.859]],["title/34",[17,1.934,22,0.979,50,0.979]],["description/34",[60,3.859]],["title/35",[61,2.686]],["description/35",[34,2.191,50,0.838,59,2.685,61,1.657]],["title/36",[10,1.934,50,0.979,61,1.934]],["description/36",[62,3.52]],["title/37",[50,0.979,57,2.197,61,1.934]],["description/37",[62,3.52]],["title/38",[17,1.934,50,0.979,61,1.934]],["description/38",[62,3.52]],["title/39",[50,0.859,57,1.927,58,2.75,61,1.696]],["description/39",[62,3.52]],["title/40",[30,2.558,50,0.979,61,1.934]],["description/40",[63,5.003]],["title/41",[64,3.553]],["description/41",[50,0.418,53,0.699,64,1.092,65,1.552,66,1.338,67,2.608,68,1.092,69,1.552,70,1.552,71,1.552,72,1.092]],["title/42",[50,0.979,55,3.135,64,2.558]],["description/42",[53,0.97,68,0.873,72,1.516,73,0.957,74,0.957,75,0.957,76,0.873,77,0.957,78,0.957,79,0.957,80,0.957,81,0.873,82,0.957,83,0.957]],["title/43",[50,0.979,54,2.558,57,2.197]],["description/43",[53,0.97,68,0.873,72,1.516,73,0.957,74,0.957,75,0.957,76,0.873,77,0.957,78,0.957,79,0.957,80,0.957,81,0.873,82,0.957,83,0.957]],["title/44",[17,1.934,50,0.979,54,2.558]],["description/44",[53,0.97,68,0.873,72,1.516,73,0.957,74,0.957,75,0.957,76,0.873,77,0.957,78,0.957,79,0.957,80,0.957,81,0.873,82,0.957,83,0.957]],["title/45",[30,2.558,50,0.979,54,2.558]],["description/45",[84,5.003]],["title/46",[85,3.052]],["description/46",[22,0.446,46,1.165,53,0.746,61,0.881,64,1.165,66,1.428,85,1.664,86,1.656,87,1.656,88,1.656]],["title/47",[10,1.696,32,2.46,38,2.46,85,1.927]],["description/47",[89,4.314]],["title/48",[32,2.805,85,2.197,90,3.636]],["description/48",[89,4.314]],["title/49",[38,3.261,85,2.555]],["description/49",[91,5.003]],["title/50",[39,2.361,85,2.197,92,3.636]],["description/50",[93,5.003]],["title/51",[94,3.052]],["description/51",[8,1.591,20,1.591,22,0.609,94,1.366,95,2.261,96,2.261,97,2.261]],["title/52",[22,0.979,94,2.197,98,3.636]],["description/52",[99,4.314]],["title/53",[22,0.859,27,2.46,81,2.244,94,1.927]],["description/53",[99,4.314]],["title/54",[17,2.249,94,2.555]],["description/54",[100,4.314]],["title/55",[76,2.975,94,2.555]],["description/55",[100,4.314]],["title/56",[28,2.191,101,2.841,102,2.841,103,2.841,104,2.841]],["description/56",[105,5.003]],["title/57",[106,3.896]],["description/57",[]],["title/58",[22,0.765,106,2.191,107,2.449,108,2.449,109,2.449]],["description/58",[110,4.314]],["title/59",[22,0.627,106,1.798,107,2.009,108,2.009,109,2.009,111,2.331,112,2.331]],["description/59",[110,4.314]]],"invertedIndex":[["",{"_index":2,"title":{},"description":{"0":{}}}],["access",{"_index":11,"title":{"2":{},"5":{},"6":{},"13":{},"14":{},"21":{},"22":{}},"description":{}}],["add",{"_index":57,"title":{"28":{},"30":{},"33":{},"37":{},"39":{},"43":{}},"description":{}}],["against",{"_index":109,"title":{"58":{},"59":{}},"description":{}}],["anoth",{"_index":41,"title":{"20":{}},"description":{}}],["api",{"_index":9,"title":{},"description":{"1":{}}}],["area",{"_index":13,"title":{},"description":{"2":{}}}],["associ",{"_index":98,"title":{"52":{}},"description":{}}],["attach",{"_index":85,"title":{"46":{},"47":{},"48":{},"49":{},"50":{}},"description":{"46":{}}}],["authent",{"_index":0,"title":{"0":{}},"description":{}}],["avail",{"_index":14,"title":{},"description":{"2":{}}}],["better",{"_index":78,"title":{},"description":{"42":{},"43":{},"44":{}}}],["call",{"_index":8,"title":{},"description":{"1":{},"8":{},"26":{},"51":{}}}],["chang",{"_index":20,"title":{"6":{},"14":{},"22":{}},"description":{"51":{}}}],["collect",{"_index":34,"title":{},"description":{"15":{},"26":{},"31":{},"35":{}}}],["column",{"_index":61,"title":{"35":{},"36":{},"37":{},"38":{},"39":{},"40":{}},"description":{"35":{},"46":{}}}],["columnar",{"_index":69,"title":{},"description":{"41":{}}}],["consid",{"_index":77,"title":{},"description":{"42":{},"43":{},"44":{}}}],["contain",{"_index":33,"title":{},"description":{"15":{},"26":{}}}],["content",{"_index":39,"title":{"18":{},"23":{},"24":{},"25":{},"50":{}},"description":{}}],["creat",{"_index":27,"title":{"9":{},"16":{},"53":{}},"description":{}}],["csv",{"_index":51,"title":{"25":{}},"description":{}}],["data",{"_index":64,"title":{"41":{},"42":{}},"description":{"41":{},"46":{}}}],["delet",{"_index":30,"title":{"12":{},"19":{},"40":{},"45":{}},"description":{}}],["deprec",{"_index":68,"title":{},"description":{"41":{},"42":{},"43":{},"44":{}}}],["describ",{"_index":15,"title":{"3":{},"10":{},"17":{}},"description":{}}],["doc",{"_index":32,"title":{"15":{},"47":{},"48":{}},"description":{}}],["docs/{docid",{"_index":37,"title":{},"description":{"17":{},"18":{},"19":{}}}],["docs/{docid}/access",{"_index":44,"title":{},"description":{"21":{},"22":{}}}],["docs/{docid}/attach",{"_index":89,"title":{},"description":{"47":{},"48":{}}}],["docs/{docid}/attachments/{attachmentid",{"_index":91,"title":{},"description":{"49":{}}}],["docs/{docid}/attachments/{attachmentid}/download",{"_index":93,"title":{},"description":{"50":{}}}],["docs/{docid}/download",{"_index":47,"title":{},"description":{"23":{}}}],["docs/{docid}/download/csv",{"_index":52,"title":{},"description":{"25":{}}}],["docs/{docid}/download/xlsx",{"_index":49,"title":{},"description":{"24":{}}}],["docs/{docid}/mov",{"_index":43,"title":{},"description":{"20":{}}}],["docs/{docid}/sql",{"_index":110,"title":{},"description":{"58":{},"59":{}}}],["docs/{docid}/t",{"_index":60,"title":{},"description":{"32":{},"33":{},"34":{}}}],["docs/{docid}/tables/{tableid}/column",{"_index":62,"title":{},"description":{"36":{},"37":{},"38":{},"39":{}}}],["docs/{docid}/tables/{tableid}/columns/{colid",{"_index":63,"title":{},"description":{"40":{}}}],["docs/{docid}/tables/{tableid}/data",{"_index":83,"title":{},"description":{"42":{},"43":{},"44":{}}}],["docs/{docid}/tables/{tableid}/data/delet",{"_index":84,"title":{},"description":{"45":{}}}],["docs/{docid}/tables/{tableid}/record",{"_index":56,"title":{},"description":{"27":{},"28":{},"29":{},"30":{}}}],["docs/{docid}/webhook",{"_index":99,"title":{},"description":{"52":{},"53":{}}}],["docs/{docid}/webhooks/queu",{"_index":105,"title":{},"description":{"56":{}}}],["docs/{docid}/webhooks/{webhookid",{"_index":100,"title":{},"description":{"54":{},"55":{}}}],["document",{"_index":22,"title":{"7":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"32":{},"33":{},"34":{},"52":{},"53":{},"58":{},"59":{}},"description":{"8":{},"15":{},"31":{},"46":{},"51":{}}}],["document'",{"_index":101,"title":{"56":{}},"description":{}}],["download",{"_index":92,"title":{"50":{}},"description":{}}],["empti",{"_index":28,"title":{"9":{},"16":{},"56":{}},"description":{}}],["endpoint",{"_index":72,"title":{},"description":{"41":{},"42":{},"43":{},"44":{}}}],["enumer",{"_index":12,"title":{},"description":{"2":{}}}],["excel",{"_index":48,"title":{"24":{}},"description":{}}],["favor",{"_index":73,"title":{},"description":{"42":{},"43":{},"44":{}}}],["fetch",{"_index":55,"title":{"27":{},"42":{}},"description":{}}],["file",{"_index":46,"title":{"23":{},"24":{},"25":{}},"description":{"46":{}}}],["format",{"_index":70,"title":{},"description":{"41":{}}}],["grist",{"_index":35,"title":{},"description":{"15":{}}}],["group",{"_index":26,"title":{},"description":{"8":{}}}],["immedi",{"_index":74,"title":{},"description":{"42":{},"43":{},"44":{}}}],["includ",{"_index":86,"title":{},"description":{"46":{}}}],["list",{"_index":10,"title":{"2":{},"5":{},"7":{},"13":{},"21":{},"32":{},"36":{},"47":{}},"description":{}}],["metadata",{"_index":38,"title":{"18":{},"47":{},"49":{}},"description":{}}],["modifi",{"_index":17,"title":{"4":{},"11":{},"18":{},"29":{},"34":{},"38":{},"44":{},"54":{}},"description":{}}],["move",{"_index":40,"title":{"20":{}},"description":{}}],["new",{"_index":81,"title":{"53":{}},"description":{"42":{},"43":{},"44":{}}}],["now",{"_index":67,"title":{},"description":{"41":{}}}],["option",{"_index":111,"title":{"59":{}},"description":{}}],["org",{"_index":3,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"20":{}},"description":{"1":{},"2":{}}}],["organ",{"_index":25,"title":{},"description":{"8":{}}}],["orgs/{orgid",{"_index":16,"title":{},"description":{"3":{},"4":{}}}],["orgs/{orgid}/access",{"_index":19,"title":{},"description":{"5":{},"6":{}}}],["orgs/{orgid}/workspac",{"_index":24,"title":{},"description":{"7":{},"9":{}}}],["paramet",{"_index":112,"title":{"59":{}},"description":{}}],["payload",{"_index":104,"title":{"56":{}},"description":{}}],["person",{"_index":6,"title":{},"description":{"1":{},"2":{}}}],["plan",{"_index":75,"title":{},"description":{"42":{},"43":{},"44":{}}}],["point",{"_index":80,"title":{},"description":{"42":{},"43":{},"44":{}}}],["project",{"_index":82,"title":{},"description":{"42":{},"43":{},"44":{}}}],["queri",{"_index":108,"title":{"58":{},"59":{}},"description":{}}],["queue",{"_index":102,"title":{"56":{}},"description":{}}],["recommend",{"_index":71,"title":{},"description":{"41":{}}}],["record",{"_index":53,"title":{"26":{},"27":{},"28":{},"29":{},"30":{}},"description":{"26":{},"41":{},"42":{},"43":{},"44":{},"46":{}}}],["refer",{"_index":87,"title":{},"description":{"46":{}}}],["remov",{"_index":76,"title":{"55":{}},"description":{"42":{},"43":{},"44":{}}}],["request",{"_index":96,"title":{},"description":{"51":{}}}],["row",{"_index":54,"title":{"43":{},"44":{},"45":{}},"description":{"26":{}}}],["run",{"_index":107,"title":{"58":{},"59":{}},"description":{}}],["same",{"_index":42,"title":{"20":{}},"description":{}}],["securitydefinit",{"_index":1,"title":{},"description":{"0":{}}}],["site",{"_index":5,"title":{},"description":{"1":{},"2":{},"8":{}}}],["space",{"_index":7,"title":{},"description":{"1":{}}}],["sql",{"_index":106,"title":{"57":{},"58":{},"59":{}},"description":{}}],["sqlite",{"_index":45,"title":{"23":{}},"description":{}}],["start",{"_index":79,"title":{},"description":{"42":{},"43":{},"44":{}}}],["structur",{"_index":59,"title":{},"description":{"31":{},"35":{}}}],["tabl",{"_index":50,"title":{"25":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"43":{},"44":{},"45":{}},"description":{"26":{},"31":{},"35":{},"41":{}}}],["team",{"_index":4,"title":{},"description":{"1":{},"2":{}}}],["trigger",{"_index":95,"title":{},"description":{"51":{}}}],["type",{"_index":88,"title":{},"description":{"46":{}}}],["undeliv",{"_index":103,"title":{"56":{}},"description":{}}],["updat",{"_index":58,"title":{"30":{},"39":{}},"description":{}}],["upload",{"_index":90,"title":{"48":{}},"description":{}}],["url",{"_index":97,"title":{},"description":{"51":{}}}],["us",{"_index":66,"title":{},"description":{"41":{},"46":{}}}],["user",{"_index":18,"title":{"5":{},"13":{},"21":{}},"description":{}}],["webhook",{"_index":94,"title":{"51":{},"52":{},"53":{},"54":{},"55":{}},"description":{"51":{}}}],["within",{"_index":23,"title":{"7":{}},"description":{}}],["work",{"_index":65,"title":{},"description":{"41":{}}}],["workspac",{"_index":21,"title":{"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"20":{}},"description":{"8":{},"15":{}}}],["workspaces/{workspaceid",{"_index":29,"title":{},"description":{"10":{},"11":{},"12":{}}}],["workspaces/{workspaceid}/access",{"_index":31,"title":{},"description":{"13":{},"14":{}}}],["workspaces/{workspaceid}/doc",{"_index":36,"title":{},"description":{"16":{}}}]],"pipeline":[]}},"options":{"theme":{"spacing":{"sectionVertical":2},"breakpoints":{"medium":"50rem","large":"50rem"},"sidebar":{"width":"0px"}},"hideDownloadButton":true,"pathInMiddlePanel":true,"scrollYOffset":48,"jsonSampleExpandLevel":"all"}}; var container = document.getElementById('redoc'); Redoc.hydrate(__redoc_state, container);