Get a workspace | Grist Octri Preview

1 parameter

workspaceIdintegerrequired

The integer identifier of the workspace to retrieve.

1 status code

200Returns the workspace details.

accessstringrequired

Allowed:ownerseditorsviewers

idintegerrequired

namestringrequired

docsarray<object>required

orgobjectrequired

Error handling

The workspaceId path parameter must be an integer that identifies an existing workspace.

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.workspaces.describe({ workspaceId: 1144 });

{
  "access": "owners",
  "id": 97,
  "name": "Secret Plans",
  "docs": [
    {
      "access": "owners",
      "id": 145,
      "isPinned": true,
      "name": "Project Lollipop",
      "urlId": null
    }
  ],
  "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