gristapi R package for easily using the Grist API

You are R developers and Grist users, we are pleased to present gristapi (GitHub - spyrales/gristapi: Package R pour communiquer avec une api Grist), an R package for easily using the Grist API. This project was born following the provision of a Grist instance for public services in France.
gristapi follows the Grist API references (REST API reference - Grist Help Center) from July 2025 and allows the management of one or more data tables.
This package is currently under development and is not published on CRAN. You can install it directly from GitHub if you’d like to try it out.
Your comments are welcome!

2 Likes

Hello, thanks for the package, it is very promising!

A colleague and I faced some difficulties in running the grist_api function for the first time. The documentation could be supplemented with additional comments or an example.

This is how we managed to make it work:

library(gristapi)

api <- grist_api$new(
  server = "https://grist.numerique.gouv.fr", #Keep the same server as in the example, regardless of your project name
  api_key = "e...1", #Personal API key available in “Account Settings”
  doc_id = "9...S" #Document ID available in the document settings

  )

Also, regarding the description of table_id, we struggled to understand that it must be referenced as a string and the first letter of the table name must be uppercase, even if the original name in GRIST does not contain one.

I hope that helped!