Grants

The permissions model. A grant gives a principal (user or email) a role (viewer / commenter / editor) on a deck or folder; folder grants cascade. Creating a grant upserts on (principal, resource).

Related guides: Sharing & permissions

Attributes

idstringrequired
objectstringrequired
principal_typestringrequired
Possible values: user, email, group, org
principalstringrequired
resource_typestringrequired
Possible values: deck, folder
resourcestringrequired
rolestringrequired
Possible values: viewer, commenter, editor
created_bystring | nullrequired
created_attimestamprequired
updated_attimestamprequired

Endpoints

GET/v1/grants
POST/v1/grants
GET/v1/grants/{id}
DELETE/v1/grants/{id}

The Grant object

{
  "id": "grt_5d2a…",
  "object": "grant",
  "principal_type": "user",
  "principal": "alice@acme.com",
  "resource_type": "deck",
  "resource": "deck_2a9f…",
  "role": "viewer",
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}