Get document metadata | Grist Octri Preview

1 parameter

docIdstringrequired

The document's UUID.

1 status code

200Returns the document's metadata, including its access, identifier, pinned status, name, URL identifier, and workspace.

accessstringrequired

Allowed:ownerseditorsviewers

idstringrequired

isPinnedbooleanrequired

namestringrequired

urlIdstringrequired

workspaceobjectrequired

Error handling

The docId path parameter must be a string UUID identifying the document to retrieve.

import (
	"context"
	"fmt"
	"log"
	"os"

	gristoctripreview "github.com/grist_octri_preview_sdk/sdk"
)

ctx := context.Background()
client := gristoctripreview.NewGristFullAPIOctriPreview(gristoctripreview.ClientConfig{
	BaseURL: "https://docs.getgrist.com/api",
	Auth: &gristoctripreview.ClientAuthConfig{ApiKey: os.Getenv("API_TOKEN")},
})

result, err := client.Docs.Describe(
	ctx,
	gristoctripreview.DescribeDocParams{DocId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"},
)
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

{
  "access": "owners",
  "id": 145,
  "isPinned": true,
  "name": "Project Lollipop",
  "urlId": null,
  "workspace": {
    "access": "owners",
    "id": 97,
    "name": "Secret Plans",
    "org": {
      "access": "owners",
      "createdAt": "2019-09-13T15:42:35.000Z",
      "domain": "gristlabs",
      "id": 42,
      "name": "Grist Labs",
      "owner": {
        "id": 101,
        "name": "Helga Hufflepuff",
        "picture": null
      },
      "updatedAt": "2019-09-13T15:42:35.000Z"
    }
  }
}

Request

Response

Errors