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 attachments API

Documents may include attached files. Data records can refer to these using a column of type `Attachments`.

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

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

This API exposes 14 operations across 11 paths, and defines 9 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.

14 operations 11 paths 9 schemas 7 GET7 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 attachments 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 14

Across 11 paths, the API surfaces 14 operations — 7 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

attachments 14

Documents may include attached files. Data records can refer to these using a column of type Attachments.

GET
/docs/{docId}/attachments
List metadata of all attachments in a doc
listAttachments 6 params → 200
POST
/docs/{docId}/attachments
Upload attachments to a doc
uploadAttachments 1 param body → 200
GET
/docs/{docId}/attachments/{attachmentId}
Get the metadata for an attachment
getAttachmentMetadata 2 params → 200
GET
/docs/{docId}/attachments/{attachmentId}/download
Download the contents of an attachment
downloadAttachment 2 params → 200
GET
/docs/{docId}/attachments/archive
Download all attachments
downloadAttachments 2 params → 200
POST
/docs/{docId}/attachments/archive
Upload missing attachments
uploadMissingAttachments 1 param body → 200
GET
/docs/{docId}/attachments/store
Get external store
getDocumentAttachmentStore 1 param → 200
POST
/docs/{docId}/attachments/store
Set external store
setDocumentAttachmentStore 1 param body → 200
GET
/docs/{docId}/attachments/stores
List external attachment stores
listAttachmentStores 1 param → 200
POST
/docs/{docId}/attachments/transferAll
Start transferring attachments
startAttachmentTransfer 1 param → 200
GET
/docs/{docId}/attachments/transferStatus
Get attachment transfer status
getAttachmentTransferStatus 1 param → 200
POST
/docs/{docId}/attachments/removeUnused
Delete unused attachments from the document
removeUnusedAttachments 2 params → 200
POST
/docs/{docId}/attachments/updateUsed
Update attachment usage tracking
updateUsedAttachments 1 param → 200
POST
/docs/{docId}/attachments/verifyFiles
Verify attachment file integrity
verifyAttachmentFiles 1 param → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are AttachmentMetadata (3 properties), AttachmentsTransferStatus (2 properties), AttachmentMetadataList (1 property), DocumentStoreSetting (1 property). Each schema is shown below with its type and property counts.

AttachmentMetadata
object
3 properties
DocumentStoreSetting
object
1 property
RowIds
array
AttachmentId
number
An integer ID
DocumentStoreId
stringnull
DocumentAttachmentsLocation
string
The current location of attachment files in the document
AttachmentMetadataList
object
1 property 1 required
AttachmentsTransferStatus
object
2 properties
AttachmentUpload
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grist-attachments-api-openapi.yml Raw ↑

Other APIs Grist publishes across the network.

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
Grist templates API
Where this information came from

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