> ## Documentation Index > Fetch the complete documentation index at: https://api-documentation.kare-app.fr/llms.txt > Use this file to discover all available pages before exploring further. # Get one commission ## OpenAPI ````yaml /api/rs/openapi.json get /rs/commissions/v1/{id} openapi: 3.0.3 info: title: KARE API description: Backend API for the KARE platform version: dev servers: - url: http://localhost:3000 description: Local dev security: [] tags: - name: better-auth description: >- Better Auth's own endpoints (sign-in, session, MFA, password) - generated from the audience's live config via `generateOpenAPISchema()`, not hand-written. paths: /rs/commissions/v1/{id}: get: tags: - commissions summary: Get one commission operationId: getCommissionRSV1 parameters: - schema: type: array items: type: string enum: - units - createdBy - report - signatures - labels - buildingWorks - actions-info - anomalies-stats - updatable-fields description: >- 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). in: query name: extend required: false - schema: type: string format: uuid 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)$ in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ visitType: type: string enum: - vc - vr - vp - vrp status: type: string enum: - to_schedule - scheduled - in_progress - pending - completed - late decision: nullable: true type: string enum: - favorable - unfavorable - no_opinion - not_provided heldAt: nullable: true type: string format: date-time comment: nullable: true type: string maxLength: 2000 autoCreated: type: boolean archivedAt: nullable: true type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time units: type: array items: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ name: type: string minLength: 1 maxLength: 150 type: type: string enum: - parent - child required: - id - ref - name - type additionalProperties: false createdBy: nullable: true type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ name: type: string required: - id - ref - name additionalProperties: false report: nullable: true type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ type: type: string enum: - pv - rvre - rvrat - cr status: type: string enum: - unreviewed - pending - processing - pending_verification - in_treatment - resolved - compliant - with_reservations checkedAt: type: string format: date-time required: - id - ref - type - status - checkedAt additionalProperties: false signatures: type: array items: type: object properties: id: type: string format: uuid 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)$ signerName: type: string minLength: 1 maxLength: 200 signerRole: type: string minLength: 1 maxLength: 200 signedAt: type: string format: date-time comment: nullable: true type: string trace: nullable: true type: object properties: strokes: minItems: 1 maxItems: 500 type: array items: maxItems: 5000 type: array items: type: object properties: x: type: number 'y': type: number t: type: number minimum: 0 required: - x - 'y' - t additionalProperties: false width: type: number minimum: 0 exclusiveMinimum: true height: type: number minimum: 0 exclusiveMinimum: true required: - strokes additionalProperties: false unit: nullable: true type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false required: - id - signerName - signerRole - signedAt - comment - trace - unit additionalProperties: false labels: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string minLength: 1 maxLength: 100 color: type: string pattern: ^#[0-9a-fA-F]{6}$ type: type: string enum: - commission - provider - document - user_profession - diploma_title - logbook required: - id - name - color - type additionalProperties: false buildingWorks: type: array items: type: object properties: id: type: string format: uuid 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: type: string maxLength: 40 pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$ authorizationNumber: type: string minLength: 1 maxLength: 200 status: type: string enum: - rejected - pending - approved - partially_received - received workNature: nullable: true type: string startAt: nullable: true type: string format: date-time endAt: nullable: true type: string format: date-time units: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false required: - id - ref - authorizationNumber - status - workNature - startAt - endAt - units additionalProperties: false actions: type: object properties: canBeUpdated: type: boolean canBeArchived: type: boolean canBeUnarchived: type: boolean canBeDeleted: type: boolean required: - canBeUpdated - canBeArchived - canBeUnarchived - canBeDeleted additionalProperties: false anomaliesStats: nullable: true type: object properties: total: type: integer minimum: 0 maximum: 9007199254740991 extracted: type: integer minimum: 0 maximum: 9007199254740991 unreviewed: type: integer minimum: 0 maximum: 9007199254740991 pending: type: integer minimum: 0 maximum: 9007199254740991 resolved: type: integer minimum: 0 maximum: 9007199254740991 required: - total - extracted - unreviewed - pending - resolved additionalProperties: false updatableFields: type: object properties: visitType: type: boolean decision: type: boolean heldAt: type: boolean comment: type: boolean unitIds: type: boolean buildingWorkIds: type: boolean labelIds: type: boolean required: - visitType - decision - heldAt - comment - unitIds - buildingWorkIds - labelIds additionalProperties: false required: - id - ref - visitType - status - decision - heldAt - comment - autoCreated - archivedAt - createdAt - updatedAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false ````