List change proposals | Grist Octri Preview

2 parameters

docIdstringrequired

A string id (UUID)

outgoingbooleanoptional

If true, list proposals where this document is the source. Otherwise list proposals where this document is the destination.

1 status code

200List of proposals

proposalsarray<object>optional

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.docs.listProposals({ docId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "proposals": [
    {
      "comparison": {
        "left": {
          "h": "example_value",
          "n": 1
        },
        "parent": {
          "h": "example_value",
          "n": 1
        },
        "right": {
          "h": "example_value",
          "n": 1
        },
        "summary": "same"
      },
      "destDocId": "550e8400-e29b-41d4-a716-446655440000",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "retracted": true,
      "srcDocId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Request

Response