> ## 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.

# Documents

> API changes for the Documents module.

<Update label="2026-09-08">
  **14 API change(s) - ⚠️ includes 8 breaking change(s)**

  **`GET /rs/documents/v1/`**

  * added the new `evacuation_plan` enum value to the `data/items/type` response property for the response status `200`
  * added the new `fire_safety_instructions` enum value to the `data/items/type` response property for the response status `200`
  * added the new `intervention_plan` enum value to the `data/items/type` response property for the response status `200`
  * added the new `safety_instructions` enum value to the `data/items/origin` response property for the response status `200`

  **`GET /rs/documents/v1/{id}`**

  * added the new `evacuation_plan` enum value to the `type` response property for the response status `200`
  * added the new `fire_safety_instructions` enum value to the `type` response property for the response status `200`
  * added the new `intervention_plan` enum value to the `type` response property for the response status `200`
  * added the new `safety_instructions` enum value to the `origin` response property for the response status `200`

  **`POST /rs/documents/v1/`**

  * added the new `evacuation_plan` enum value to the request property `type`
  * added the new `fire_safety_instructions` enum value to the request property `type`
  * added the new `intervention_plan` enum value to the request property `type`

  **`PATCH /rs/documents/v1/{id}`**

  * added the new `evacuation_plan` enum value to the request property `type`
  * added the new `fire_safety_instructions` enum value to the request property `type`
  * added the new `intervention_plan` enum value to the request property `type`
</Update>

<Update label="2026-09-07">
  **1 API change(s) - ⚠️ includes 1 breaking change(s)**

  **`GET /rs/documents/v1/`**

  * for the `query` request parameter `whereCreatedById`, the type/format of property `items/` was specialized from `string`/\`\` to `string`/`uuid`
</Update>

<Update label="2026-08-28 (#697)">
  **11 API change(s) - ⚠️ includes 2 breaking change(s)**

  **`GET /rs/documents/v1/`**

  * added the new `contract` enum value to the `data/items/type` response property for the response status `200`
  * added the new optional `query` request parameter `whereLabelIds`
  * added the enum value `label` to the property `items/` of the `query` request parameter `extend`
  * added the optional property `data/items/label` to the response with the `200` status

  **`GET /rs/documents/v1/{id}`**

  * added the new `contract` enum value to the `type` response property for the response status `200`
  * added the enum value `label` to the property `items/` of the `query` request parameter `extend`
  * added the optional property `label` to the response with the `200` status

  **`POST /rs/documents/v1/`**

  * added the new optional request property `labelId`
  * added the new `contract` enum value to the request property `type`

  **`PATCH /rs/documents/v1/{id}`**

  * added the new optional request property `labelId`
  * added the new `contract` enum value to the request property `type`
</Update>

<Update label="2026-08-28">
  **4 API change(s) - ⚠️ includes 2 breaking change(s)**

  **`POST /rs/documents/v1/{id}/archive`**

  * api path removed without deprecation

  **`POST /rs/documents/v1/{id}/unarchive`**

  * api path removed without deprecation

  **`POST /rs/documents/v1/batch-archive`**

  * endpoint added

  **`POST /rs/documents/v1/batch-unarchive`**

  * endpoint added
</Update>

<Update label="2026-08-27 (#696)">
  **3 API change(s) - ⚠️ includes 1 breaking change(s)**

  **`GET /rs/documents/v1/{id}`**

  * removed the required property `versions/items/replacedByUserId` from the response with the `200` status
  * added the required property `versions/items/downloadUrl` to the response with the `200` status
  * added the required property `versions/items/replacedBy` to the response with the `200` status
</Update>

<Update label="2026-08-27 (#691)">
  **4 API change(s)**

  **`GET /rs/documents/v1/`**

  * added the enum value `source` to the property `items/` of the `query` request parameter `extend`
  * added the optional property `data/items/source` to the response with the `200` status

  **`GET /rs/documents/v1/{id}`**

  * added the enum value `source` to the property `items/` of the `query` request parameter `extend`
  * added the optional property `source` to the response with the `200` status
</Update>

<Update label="2026-08-27 (#695)">
  **14 API change(s) - ⚠️ includes 14 breaking change(s)**

  **`POST /rs/documents/v1/`**

  * removed the enum value `application/x-7z-compressed` of the request property `mimeType`
  * removed the enum value `application/zip` of the request property `mimeType`
  * removed the enum value `image/gif` of the request property `mimeType`
  * removed the enum value `image/jpeg` of the request property `mimeType`
  * removed the enum value `image/jpg` of the request property `mimeType`
  * removed the enum value `image/png` of the request property `mimeType`
  * removed the enum value `image/svg+xml` of the request property `mimeType`

  **`POST /rs/documents/v1/{id}/replace`**

  * removed the enum value `application/x-7z-compressed` of the request property `mimeType`
  * removed the enum value `application/zip` of the request property `mimeType`
  * removed the enum value `image/gif` of the request property `mimeType`
  * removed the enum value `image/jpeg` of the request property `mimeType`
  * removed the enum value `image/jpg` of the request property `mimeType`
  * removed the enum value `image/png` of the request property `mimeType`
  * removed the enum value `image/svg+xml` of the request property `mimeType`
</Update>

<Update label="2026-08-27">
  **6 API change(s) - ⚠️ includes 3 breaking change(s)**

  **`GET /rs/documents/v1/`**

  * for the `query` request parameter `whereBuildingWorkId`, the type/format was changed from `string`/`uuid` to `array`/\`\`
  * for the `query` request parameter `whereTechnicalInstallationId`, the type/format was changed from `string`/`uuid` to `array`/\`\`
  * for the `query` request parameter `whereUnitId`, the type/format was changed from `string`/`uuid` to `array`/\`\`
  * removed the 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)$` from the `query` request parameter `whereBuildingWorkId`
  * removed the 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)$` from the `query` request parameter `whereTechnicalInstallationId`
  * removed the 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)$` from the `query` request parameter `whereUnitId`
</Update>

<Update label="2026-08-26">
  **1 API change(s)**

  **`GET /rs/documents/v1/`**

  * added the new optional `query` request parameter `countOnly`
</Update>

<Update label="2026-08-03">
  **4 API change(s) — ⚠️ includes 2 breaking change(s)**

  **`GET /rs/documents/v1/`**

  * added the new `cr` enum value to the `data/items/type` response property for the response status `200`

  **`GET /rs/documents/v1/{id}`**

  * added the new `cr` enum value to the `type` response property for the response status `200`

  **`POST /rs/documents/v1/`**

  * added the new `cr` enum value to the request property `type`

  **`PATCH /rs/documents/v1/{id}`**

  * added the new `cr` enum value to the request property `type`
</Update>

<Update label="2026-07-24">
  **1 API change(s)**

  **`GET /rs/documents/v1/{id}`**

  * added the new optional `query` request parameter `extend`
</Update>

<Update label="2026-07-20">
  **8 API change(s)**

  **`GET /rs/documents/v1/`**

  * endpoint added

  **`POST /rs/documents/v1/`**

  * endpoint added

  **`DELETE /rs/documents/v1/{id}`**

  * endpoint added

  **`GET /rs/documents/v1/{id}`**

  * endpoint added

  **`PATCH /rs/documents/v1/{id}`**

  * endpoint added

  **`POST /rs/documents/v1/{id}/archive`**

  * endpoint added

  **`POST /rs/documents/v1/{id}/replace`**

  * endpoint added

  **`POST /rs/documents/v1/{id}/unarchive`**

  * endpoint added
</Update>