Skip to main content
GET
Get a document

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

documentId
string<uuid>
required

Document unique identifier

projectId
string<uuid>
required

Project unique identifier

Query Parameters

deleted
default:false

Include deleted documents

Available options:
true,
false,
True,
False,
TRUE,
FALSE

Response

200 - application/json

Document with full details

Document with full details

id
string<uuid>
required

Document unique identifier

key
string
required

Materialized lowercase path based on the name

path
string
required

Materialized path based on the name

name
string
required

Document name

type
enum<string>
required

Document type (file, directory, or external file)

Available options:
f,
d,
e
projectId
string<uuid>
required

Project ID

meta
object

Document metadata

contentType
string

Content MIME type

size
number

Document size in bytes

parentId
string<uuid> | null

Parent document ID

publishedId
string<uuid> | null

Currently published version ID

publishedAt
string | null

Publication timestamp

publishedBy
object

User who published the document

published
object

Published version details

versions
object[]

Document versions

changeRequests
object[]

Pending change requests

view
object | null

Document view configuration

updatedAt
string

Last update timestamp

deletedAt
string | null

Deletion timestamp if soft deleted