Skip to main content
GET
Get one document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "folder": Include the containing folder (id, name), null when unclassified.
  • "label": Include the linked label (id, name, color) when present.
  • "unit": Include the linked unit (id, name), null for an org-level document.
  • "technical-installation": Include the linked technical installation (id, name), null when not linked.
  • "created-by": Adds the document author (createdByUser with display name).
  • "versions": Adds versions, the append-only replacement history, most recent first, each with a presigned downloadUrl and the resolved replacedBy user.
  • "actions-info": Adds actions (canBe* flags) and isConstitutive (owned by a report/plan/contract).
  • "source": Include the carrier entity (report, contract, plan, building work) the document comes from, null for a plain upload.
Available options:
folder,
label,
unit,
technical-installation,
created-by,
versions,
actions-info,
source

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ref
string
required
Maximum string length: 40
Pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$
name
string
required
Required string length: 1 - 255
type
enum<string>
required
Available options:
cerfa,
security_notice,
plan,
fire_safety_instructions,
evacuation_plan,
intervention_plan,
bl,
invoice,
quote,
schema,
pv,
rvre,
cr,
contract,
other
origin
enum<string>
required
Available options:
site_upload,
building_work,
report,
plan,
contract,
safety_instructions
mimeType
string
required
Required string length: 1 - 100
size
integer
required
Required range: 0 < x <= 1073741824
folderId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
unitId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
technicalInstallationId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
buildingWorkId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
downloadUrl
string<uri>
required
folder
object | null
label
object | null
unit
object | null
technicalInstallation
object | null
createdByUser
object | null
versions
object[]
actions
object
isConstitutive
boolean
source
object | null