Grist API Reference

概要

Serves as a comprehensive technical guide for developers working with Grist, offering deep access to REST API specifications, TypeScript type definitions, and internal database structures. It streamlines the process of building integrations by providing detailed references for cell value encoding, UserAction formats, and metadata table relationships. Beyond standard API calls, it includes practical instructions for configuring UI components like widgets and page layouts, making it an essential resource for anyone extending or automating Grist-based workflows.

主な機能

• TypeScript type definitions for cell values, widget options, and UserActions
• Comprehensive OpenAPI 3.0 REST API documentation and endpoint schemas
• Implementation guides for page layouts, widget linking, and sorting logic
• Detailed mapping of Grist internal metadata tables and database structure
• 0 GitHub stars
• Verification patterns for validating action results via the /apply endpoint

ユースケース

• Building and maintaining MCP servers or custom API integrations for Grist
• Designing complex database schemas and cross-table metadata relationships
• Configuring advanced UI widgets, layouts, and dynamic data linking structures