Get document attachment transfer status

1 parameter

docIdstringrequired

The UUID of the document whose attachment transfer status to retrieve.

1 status code

200Returns the transfer status, including the current attachment location summary and transfer progress details.

locationSummarystringoptional

The current location of attachment files in the document

Allowed:noneinternalmixedexternal

statusobjectoptional

Error handling

The docId path parameter must be a UUID identifying a document.

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.attachments.getTransferStatus({ docId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "locationSummary": "mixed",
  "status": {
    "isRunning": true,
    "pendingTransferCount": 19
  }
}

Request

Response

Errors