Skip to main content
GET
Get one commission

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"]):

  • "units": Include the linked units (id, ref, name, type).
  • "createdBy": Include the creator's identity as createdBy (id, ref, name).
  • "report": Include the linked PV report (id, ref, type, status) when present.
  • "signatures": Include the collected signatures (signer, role, date, establishment). A multi-unit visit is signed once per establishment.
  • "labels": Include the linked labels (id, name, color, type).
  • "buildingWorks": Include the linked building works (id, ref, authorizationNumber, status).
  • "actions-info": Adds actions (canBeUpdated / canBeArchived / canBeUnarchived / canBeDeleted).
  • "anomalies-stats": Adds anomaliesStats (counts of the linked report anomalies by status; null when no report).
  • "updatable-fields": Adds updatableFields (per-field editability).
Available options:
units,
createdBy,
report,
signatures,
labels,
buildingWorks,
actions-info,
anomalies-stats,
updatable-fields

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*)*$
visitType
enum<string>
required
Available options:
vc,
vr,
vp,
vrp
status
enum<string>
required
Available options:
to_schedule,
scheduled,
in_progress,
pending,
completed,
late
decision
enum<string> | null
required
Available options:
favorable,
unfavorable,
no_opinion,
not_provided
heldAt
string<date-time> | null
required
comment
string | null
required
Maximum string length: 2000
autoCreated
boolean
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
units
object[]
createdBy
object | null
report
object | null
signatures
object[]
labels
object[]
buildingWorks
object[]
actions
object
anomaliesStats
object | null
updatableFields
object