Get users for 'View As' feature | Grist Octri Preview

1 parameter

docIdstringrequired

A string id (UUID)

1 status code

200Users available for View As

attributeTableUsersarray<object>optional

Users found in user attribute tables

exampleUsersarray<object>optional

Predefined example users

usersarray<object>optional

Users the document is shared with

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

{
  "attributeTableUsers": [
    {
      "id": 101,
      "name": "Helga Hufflepuff",
      "picture": null
    }
  ],
  "exampleUsers": [
    {
      "id": 101,
      "name": "Helga Hufflepuff",
      "picture": null
    }
  ],
  "users": [
    {
      "id": 101,
      "name": "Helga Hufflepuff",
      "picture": null
    }
  ]
}

Request

Response