The ID of the table to create rows in.
An object containing an items
array of row data objects.
Optional
params: Omit<CreateRowParams, "before"> & { before?: null | number }Optional query parameters like 'before', 'send_webhook_events', 'user_field_names'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
An object containing an items
array with the newly created rows.
Deletes multiple rows from a table in a single batch request.
The ID of the table containing the rows.
An array of row IDs to delete.
Optional
params: DeleteRowParamsOptional query parameters like 'send_webhook_events'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
Updates multiple rows in a table in a single batch request.
The ID of the table containing the rows.
An object containing an items
array of row objects, each including its id
and the fields to update.
Optional
params: UpdateRowParamsOptional query parameters like 'send_webhook_events', 'user_field_names'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
An object containing an items
array with the updated rows.
Creates a new row in a table.
The ID of the table to create the row in.
An object representing the row data. Keys should be field_{id}
or field names if user_field_names is true.
Optional
params: CreateRowParamsOptional query parameters like 'before', 'send_webhook_events', 'user_field_names'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
The newly created row.
Creates a comment on a specific row. (Premium feature)
The ID of the table.
The ID of the row to comment on.
The comment content.
The newly created comment.
Deletes a row from a table.
The ID of the table containing the row.
The ID of the row to delete.
Optional
params: DeleteRowParamsOptional query parameters like 'send_webhook_events'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
Deletes a row comment. Only the author can delete their comment. (Premium feature)
The ID of the table containing the comment's row.
The ID of the comment to delete.
The deleted comment object (based on spec, confirm if it actually returns content or just 204).
Fetches a single row from a table.
The ID of the table.
The ID of the row to fetch.
Optional
params: { include?: "metadata"; userFieldNames?: boolean }Optional parameters like 'include' or 'user_field_names'.
The requested row.
Fetches the adjacent row (previous or next) to a given row within a table, optionally applying view filters/sorts.
The ID of the table.
The ID of the reference row.
Optional
params: GetAdjacentRowParamsOptional parameters: 'previous' flag, 'view_id', 'search', 'user_field_names'.
The adjacent row or null if no adjacent row exists matching the criteria.
Fetches the change history for a specific row.
The ID of the table.
The ID of the row.
Optional
params: ListRowHistoryParamsOptional pagination parameters ('limit', 'offset').
A paginated list of row history entries.
Lists rows in a table, with support for pagination, filtering, sorting, and searching.
The ID of the table to list rows from.
Optional
params: ListRowsParamsOptional query parameters for pagination, filtering, sorting, etc.
A paginated list of rows.
Lists comments for a specific row. (Premium feature)
The ID of the table.
The ID of the row.
Optional
params: ListRowCommentsParamsOptional pagination parameters.
A paginated list of row comments.
Fetches the primary field values (names) for specific rows across one or more tables.
An object where keys are table__<id>
and values are comma-separated row IDs.
An object mapping table IDs to row IDs to row names.
Moves a row within a table.
The ID of the table containing the row.
The ID of the row to move.
Optional
params: MoveRowParamsQuery parameters specifying where to move the row ('before_id') and optionally 'user_field_names'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
The moved row with its potentially updated order.
Updates an existing row in a table.
The ID of the table containing the row.
The ID of the row to update.
An object containing the fields to update. Keys should be field_{id}
or field names if user_field_names is true.
Optional
params: UpdateRowParamsOptional query parameters like 'send_webhook_events', 'user_field_names'.
Optional
options: { clientSessionId?: string; clientUndoRedoActionGroupId?: string }Optional request parameters like ClientSessionId or ClientUndoRedoActionGroupId.
The updated row.
Updates an existing row comment. Only the author can update their comment. (Premium feature)
The ID of the table containing the comment's row.
The ID of the comment to update.
The updated comment content.
The updated comment.
Updates the user's notification preferences for comments on a specific row. (Premium feature)
The ID of the table.
The ID of the row.
The desired notification mode ('all' or 'mentions').
Creates multiple rows in a table in a single batch request.