Get a document

Returns a document's metadata. Its contents are read through the spreadsheet endpoints.

GET /v1/documents/:id

Permission

The key must be granted docs.documents.read

A key without it gets 403 insufficient_scope, with the missing permission named in details.

Metadata only. A spreadsheet's contents are read through the spreadsheet endpoints, which is why this stays cheap on a large workbook.

Path parameters

Field	Type	Description
`id` required	string	The document to read.

Request

curl https://api.veruapis.com/v1/documents/:id \
  -H "Authorization: Bearer vak_live_..."

Response

Field	Type	Description
`id`	string
`type`	string	`documentspreadsheet`
`title`	string
`state`	string	`activetrashed`
`owner_id`	string	The workspace user who owns it, which is not necessarily the key's owner.
`folder_id`	string	Empty for a document in the root.
`metadata`	object	Whatever you stored on it.
`created_at`	RFC 3339
`updated_at`	RFC 3339

{
  "data": {
  "id": "0192a1c2-6f3e-7a41-b8d2-5e9f0c3a7b41",
  "type": "spreadsheet",
  "title": "Q3 plan",
  "state": "active",
  "owner_id": "01918e4b-7c2e-7f11-b4a9-0242ac130003",
  "folder_id": "0192f001-0000-7a41-b8d2-5e9f0c3a7b41",
  "metadata": {},
  "created_at": "2026-09-01T10:00:00Z",
  "updated_at": "2026-09-09T16:20:00Z"
},
  "meta": { "request_id": "req_01j8z9...", "timestamp": "2026-09-02T10:00:00Z" }
}

Worth knowing

Metadata only, so this stays cheap on a large workbook. Contents are read through the spreadsheet endpoints.

Errors

Every failure uses the same shape, with a stable string code you can branch on. See the error reference.

GET `/v1/documents/:id`

Your API key Used once, never stored.

id

Query

Get a document

Permission

Path parameters

Request

Response

Related