list_grids
Discover spreadsheet-like data tables in your BitScale workspace with their column definitions to identify available grids before running enrichment or formula operations.
Instructions
List all Grids in the workspace with their column definitions.
Grids are spreadsheet-like tables in BitScale that hold data rows and enrichment/formula columns. Use this to discover available grids before running them.
Args: search: Optional keyword to filter grids by name (case-insensitive substring match). Example: "leads" to find lead-related grids. page: Page number for pagination (1-based, default: 1). limit: Results per page (default: 20, max: 100).
Returns: paginated list of grids, each with id, name, description, row_count, column_count, created_at, updated_at, and columns array. The columns array contains only runnable columns (type: enrichment, formula, or merge) with their id (column UUID), name, type, and dependencies.
Use the grid id from the results to call get_grid_details or run_grid. Note: the column UUIDs here are used for output_columns in run_grid. The input labels for run_grid are separate human-readable keys derived from the grid's API data source configuration.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | ||
| page | No | ||
| limit | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- main.py:87-120 (handler)The list_grids function retrieves a paginated list of grids from the /grids endpoint and returns them as a JSON string.
def list_grids( search: str = "", page: int = 1, limit: int = 20, ) -> str: """ List all Grids in the workspace with their column definitions. Grids are spreadsheet-like tables in BitScale that hold data rows and enrichment/formula columns. Use this to discover available grids before running them. Args: search: Optional keyword to filter grids by name (case-insensitive substring match). Example: "leads" to find lead-related grids. page: Page number for pagination (1-based, default: 1). limit: Results per page (default: 20, max: 100). Returns: paginated list of grids, each with id, name, description, row_count, column_count, created_at, updated_at, and columns array. The columns array contains only runnable columns (type: enrichment, formula, or merge) with their id (column UUID), name, type, and dependencies. Use the grid id from the results to call get_grid_details or run_grid. Note: the column UUIDs here are used for output_columns in run_grid. The input labels for run_grid are separate human-readable keys derived from the grid's API data source configuration. """ params: dict = {"page": page, "limit": limit} if search: params["search"] = search data = _get("/grids", params=params) return json.dumps(data, indent=2)