> ## 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. # List technical installations (paginated/filterable) ## OpenAPI ````yaml /api/rs/openapi.json get /rs/technical-installations/v1/ 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/technical-installations/v1/: get: tags: - technical-installations summary: List technical installations (paginated/filterable) operationId: listTechnicalInstallationsRSV1 parameters: - schema: default: 1 type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 in: query name: page required: false - schema: default: 50 type: integer minimum: 0 exclusiveMinimum: true maximum: 1000 in: query name: pageSize required: false - schema: example: true anyOf: - type: boolean in: query name: countOnly required: false description: >- When true, answers `totalCount` with an empty `data`: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter. - schema: type: array items: type: string enum: - sites - actions-info - updatable-fields - library-technical-installation - responsibles - created-by description: >- Extend options (JSON-encoded array, e.g. `?extend=["category"]`): - "sites": Adds `sites` (the active sites each installation is present on). - "actions-info": Projects `{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }`. - "updatable-fields": Per-field write rules for each installation in its current state. - "library-technical-installation": Adds `libraryTechnicalInstallation` (the library entry this installation was adopted from, for grouping instances by type). - "responsibles": Adds `responsibles` - the users responsible for this element. - "created-by": Adds `createdBy` (the user who created each technical installation). in: query name: extend required: false - schema: type: array items: type: object properties: field: type: string enum: - name - ref - createdAt - updatedAt - archivedAt description: >- OrderBy options (JSON-encoded array, e.g. `?orderBy=[{"field":"name","direction":"asc"}]`): - "name": Order by name. - "ref": Order by ref. - "createdAt": Order by creation date. - "updatedAt": Order by last-update date. - "archivedAt": Order by archive date. direction: type: string enum: - asc - desc description: Sort direction example: asc required: - field - direction in: query name: orderBy required: false - schema: type: string maxLength: 200 example: lobby in: query name: whereSearch required: false description: Case-insensitive search across name and ref. - schema: type: string maxLength: 200 example: lobby in: query name: whereName required: false description: Case-insensitive partial match on the name. - schema: maxItems: 250 type: array items: 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)$ example: - 550e8400-e29b-41d4-a716-446655440000 - 6ba7b810-9dad-11d1-80b4-00c04fd430c8 in: query name: whereUnitIds required: false description: Narrow linked technical installations to the requested unit ids. - schema: maxItems: 250 type: array items: 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)$ example: - 550e8400-e29b-41d4-a716-446655440000 - 6ba7b810-9dad-11d1-80b4-00c04fd430c8 in: query name: whereITIds required: false description: Narrow the result to the requested technical installation ids. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereArchived required: false description: When `true`, only archived; when `false`, only non-archived. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereProvenance required: false description: When `true`, only library-adopted; when `false`, only org-created. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereCreatedAt required: false description: Filter by creation date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereUpdatedAt required: false description: Filter by last-update date range. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereImResponsible required: false description: >- When `true`, restricts to technical installations the current user is responsible for - holding a responsibility on the installation itself or on one of the units it serves. Narrows the caller’s visibility scope, never widens it. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereIncludeDeleted required: false description: When `true`, also returns soft-deleted technical installations. responses: '200': description: Default Response content: application/json: schema: type: object properties: data: 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 nameTranslations: nullable: true type: object additionalProperties: type: string minLength: 1 maxLength: 200 image: nullable: true type: object properties: name: type: string minLength: 1 maxLength: 255 mimeType: type: string minLength: 1 maxLength: 100 size: type: integer minimum: 0 exclusiveMinimum: true maximum: 1073741824 downloadUrl: type: string format: uri required: - name - mimeType - size - downloadUrl additionalProperties: false libraryTechnicalInstallationId: nullable: true 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)$ libraryVersion: nullable: true type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 archivedAt: nullable: true type: string format: date-time deletedAt: nullable: true type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time sites: 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 required: - id - ref - name 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 updatableFields: type: object properties: name: type: boolean sites: type: boolean image: type: boolean required: - name - sites - image additionalProperties: false libraryTechnicalInstallation: 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)$ nameFr: type: string minLength: 1 maxLength: 150 nameEn: type: string minLength: 1 maxLength: 150 nameDe: type: string minLength: 1 maxLength: 150 required: - id - nameFr - nameEn - nameDe additionalProperties: false responsibles: 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 email: nullable: true type: string required: - id - name - email additionalProperties: false createdBy: 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 required: - id - ref - name - nameTranslations - image - libraryTechnicalInstallationId - libraryVersion - archivedAt - deletedAt - createdAt - updatedAt additionalProperties: false totalCount: type: integer minimum: 0 maximum: 9007199254740991 pagination: type: object properties: page: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 pageSize: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 totalPages: type: integer minimum: 0 maximum: 9007199254740991 required: - page - pageSize - totalPages additionalProperties: false required: - data - totalCount - pagination 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 ````