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.
openapi: 3.2.0
info:
description: 'An API for manipulating Grist sites, workspaces, and documents.
# Authentication
<SecurityDefinitions />
'
version: 1.0.1
title: Grist attachments Widgets API
servers:
- url: https://{gristhost}/api
variables:
subdomain:
description: The team name, or `docs` for personal areas
default: docs
security:
- ApiKey: []
tags:
- name: widgets
paths:
/widgets:
get:
operationId: listWidgets
tags:
- widgets
summary: List available custom widgets
description: 'Get all widget definitions from the configured widget repository.
Custom widgets extend Grist''s functionality with specialized views.
'
responses:
200:
description: List of widgets
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
description: Widget display name
url:
type: string
description: URL to load the widget
widgetId:
type: string
description: Unique widget identifier
components:
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.