How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Grist workspaces API

Sites can be organized into groups of documents called workspaces.

Grist workspaces API is one of 17 APIs that Grist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, https://{gristhost}/api.

9 operations 5 paths 12 schemas 1 DELETE3 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://docs.getgrist.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Grist workspaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization: Bearer XXXXXXXXXXX) (ApiKey). By default, every request must be authenticated.

  • ApiKey — 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.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

workspaces 9

Sites can be organized into groups of documents called workspaces.

GET
/orgs/{orgId}/workspaces
List workspaces and documents within an org
listWorkspaces 1 param → 200
POST
/orgs/{orgId}/workspaces
Create an empty workspace
createWorkspace 1 param body → 200
GET
/workspaces/{workspaceId}
Describe a workspace
describeWorkspace 1 param → 200
PATCH
/workspaces/{workspaceId}
Modify a workspace
modifyWorkspace 1 param body → 200
DELETE
/workspaces/{workspaceId}
Delete a workspace
deleteWorkspace 1 param → 200
POST
/workspaces/{workspaceId}/remove
Move workspace to trash
removeWorkspace 2 params → 200
POST
/workspaces/{workspaceId}/unremove
Restore workspace from trash
unremoveWorkspace 1 param → 200
GET
/workspaces/{workspaceId}/access
List users with access to workspace
listWorkspaceAccess 1 param → 200
PATCH
/workspaces/{workspaceId}/access
Change who has access to workspace
modifyWorkspaceAccess 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Org (7 properties), Doc (5 properties), User (3 properties), Workspace (3 properties). Each schema is shown below with its type and property counts.

Workspace
object
3 properties 3 required
WorkspaceParameters
object
1 property
WorkspaceWithDocsAndDomain
WorkspaceWithDocs
User
object
3 properties 3 required
WorkspaceAccessRead
object
2 properties 2 required
Org
object
7 properties 7 required
WorkspaceAccessWrite
object
2 properties
WorkspaceWithDocsAndOrg
Access
string
Doc
object
5 properties 5 required
WorkspaceWithOrg

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grist-workspaces-api-openapi.yml Raw ↑

Other APIs Grist publishes across the network.

Grist attachments API
Grist columns API
Grist data API
Grist docs API
Grist forms API
Grist orgs API
Grist profile API
Grist records API
Grist service accounts API
Grist session API
Grist sql API
Grist tables API
Where this information came from

This is an independent, third-party profile of Grist workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.