Skip to main content
Get document metadata

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as index.status. id is always returned. Fields: id, file_name, mime_type, file_size, page_count, md5_checksum, properties, created_at, updated_at, version, previous_version_id, index.

Response

Document metadata.

id
string<uuid>
required
file_name
string
required
mime_type
string | null
required
file_size
integer | null
required
page_count
integer | null
required
md5_checksum
string | null
required

Base64 MD5 of the file. Null until the upload has been verified.

properties
object | null
required

What the file contains, keyed by kind. For workbook (XLSX): each worksheet in order, with its name, whether it is hidden, and row_count (rows with at least one non-empty cell). Null when not available for this file.

created_at
string<date-time>
required
updated_at
string<date-time> | null
required
version
integer | null
required
previous_version_id
string<uuid> | null
required
index
object
required