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 service accounts API

Impersonations to manage grist resources through REST APIs with specific rights.

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

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

This API exposes 7 operations across 3 paths, and defines 5 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.

7 operations 3 paths 5 schemas 2 DELETE2 GET1 PATCH2 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 service accounts 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 7

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

service accounts 7

Impersonations to manage grist resources through REST APIs with specific rights.

GET
/service-accounts
Get all your service accounts
listServiceAccounts → 200403
POST
/service-accounts
Create a service account
createServiceAccount body → 200403
GET
/service-accounts/{saId}
Get a service account's details
getServiceAccount 1 param → 200403404
PATCH
/service-accounts/{saId}
Modify a service account
modifyServiceAccount 1 param body → 200403404
DELETE
/service-accounts/{saId}
Delete a service account
deleteServiceAccount 1 param → 200403404
POST
/service-accounts/{saId}/apikey
Generate a new service account's api key
regenerateServiceAccountApiKey 1 param → 200403404
DELETE
/service-accounts/{saId}/apikey
Delete a service account's api key
deleteServiceAccountApiKey 1 param → 200403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ServiceAccountResult (6 properties), ServiceAccountBody (3 properties). Each schema is shown below with its type and property counts.

ServiceAccountsResult
array
CreateServiceAccount
ServiceAccountResult
object
6 properties 6 required
ServiceAccountResultWithApiKey
ServiceAccountBody
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grist-service-accounts-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 session API
Grist sql API
Grist tables API
Grist templates API
Where this information came from

This is an independent, third-party profile of Grist service accounts 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.