---
title: "Get document permissions"
method: GET
path: "/api/v1/documents/{identifier}/permissions"
tags: ["Documents"]
---

# Get document permissions

`GET /api/v1/documents/{identifier}/permissions`

Returns the document-level ability values (the Share dialog "Abilities" toggles), plus the resolved permits for a specific user when `userId` is provided.

## Path parameters

- `identifier` string, required — Document identifier (either document ID or identifier slug)

## Query parameters

- `userId` string, uuid — User membership ID to check permissions for. When omitted, only the document-level abilities are returned.

## Response `200`

Document abilities, plus user permits when userId is provided

- DocumentsGetPermissionsResponse
  - `abilities` DocumentAbilities, required — Document-level ability values, as stored on the document
    - `canAnalyze` boolean, required — Allow exploring from this document
    - `canDownload` boolean, required — Allow downloading
    - `canDrill` boolean, required — Allow drill-down
    - `canDuplicate` boolean, required — Allow duplicating
    - `canRequestAccess` boolean, required — Allow requesting access
    - `canSaveSpreadsheets` boolean, required — Allow creating spreadsheets
    - `canSchedule` boolean, required — Allow scheduling
    - `canUpload` boolean, required — Allow uploads
    - `canUseDashboardAi` boolean, required — Allow using dashboard AI
    - `canUseTimezoneOverride` boolean, required — Allow timezone override
    - `canViewWorkbook` boolean, required — Allow viewing workbook
    - `requirePullRequestToPublish` boolean, required — Require pull request to publish changes
  - `permits` unknown

## Other responses

- `401` — Authentication required
- `403` — Permission denied
- `404` — Document or user not found

## Changes

> 22 revisions in range; 18 could not be searched.

- **2026-07-26** `f65b6ea0a62f` — 2 info
  - the `query` request parameter `userId` became optional
  - added the required property `abilities` to the response with the `200` status

[Change history](https://skmtc.dev/omniapp/apis/omni-api/changes/api/v1/documents/:identifier/permissions/get.md)

---

[API](https://skmtc.dev/omniapp/apis/omni-api.md) · [All operations](https://skmtc.dev/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/omniapp/omni-api/revisions/2ed3f36eff42/schema)