Tool to retrieve records from a specified table within a Grist document. Use when you need to fetch rows by applying optional filters, sorting, limits, or hidden columns. Example: list records where pet is 'cat' sorted by '-age'.
sortstringComma-separated columns to sort by; prefix with '-' for descending. Supports options via ':choiceOrder', 'naturalSort', 'emptyFirst'.
docIdRequiredstringDocument ID (alphanumeric string) of the Grist document. Obtain this from GRIST_LIST_WORKSPACES or GRIST_CREATE_DOCUMENT.
limitintegerMaximum number of rows to return; 0 means no limit.
filterstringURL-encoded JSON mapping column names to allowed values arrays. Example: '{"pet":["cat","dog"]}'.
hiddenbooleanIf true, include hidden columns (e.g., manualSort).
tableIdRequiredstringTable identifier (normalized name) or numeric _grist_Tables row ID.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.