Grist forms API

The forms API from Grist — 1 operation(s) for forms.

Operations 1

GET /docs/{docId}/forms/{viewSectionId} Get form view data #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/grist-forms-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

grist-forms-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'An API for manipulating Grist sites, workspaces, and documents.


    # Authentication

    <SecurityDefinitions />

    '
  version: 1.0.1
  title: Grist attachments Forms API
servers:
- url: https://{gristhost}/api
  variables:
    subdomain:
      description: The team name, or `docs` for personal areas
      default: docs
security:
- ApiKey: []
tags:
- name: forms
paths:
  /docs/{docId}/forms/{viewSectionId}:
    get:
      operationId: getFormData
      tags:
      - forms
      summary: Get form view data
      description: 'Get the form configuration for a specific view section. Forms are

        a special view type that allows external users to submit data.

        '
      parameters:
      - $ref: '#/components/parameters/docIdPathParam'
      - name: viewSectionId
        in: path
        required: true
        schema:
          type: integer
        description: ID of the view section (form)
      responses:
        200:
          description: Form data
          content:
            application/json:
              schema:
                type: object
                properties:
                  formFieldsById:
                    type: object
                    description: Form fields indexed by field ID
                  formLayoutSpec:
                    type: string
                    description: JSON layout specification for the form
                  formTableId:
                    type: string
                    description: ID of the table the form submits to
                  formTitle:
                    type: string
                    description: Title of the form
        404:
          description: Form not found
components:
  parameters:
    docIdPathParam:
      in: path
      name: docId
      schema:
        type: string
      description: A string id (UUID)
      required: true
  securitySchemes:
    ApiKey:
      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.