> ## 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 equipments (paginated/filterable) ## OpenAPI ````yaml /api/rs/openapi.json get /rs/equipments/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/equipments/v1/: get: tags: - equipments summary: List equipments (paginated/filterable) operationId: listEquipmentsRSV1 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: - technical-installation - unit - installed-by - position - contained-in - specifications - qrcode - qrcodes - counts - actions-info - updatable-fields - responsibles - created-by description: >- Extend options (JSON-encoded array, e.g. `?extend=["category"]`): - "technical-installation": Adds `technicalInstallation` (each equipment's technical installation). - "unit": Adds `unit` (the unit each equipment is attached to, nullable). - "installed-by": Adds `installedBy` (the installer provider, nullable). - "position": Adds `position` (the marker on a plan, nullable). - "contained-in": Adds `containedIn` (the zones/rooms each equipment sits in). - "specifications": Adds `specifications` (the specification values tagging each equipment). - "qrcode": Adds `qrcode` (the QR code associated to each equipment, nullable). - "qrcodes": Adds `qrcodes` (every QR code associated to each equipment, by serial number). - "counts": Adds `counts` (anomalies by processing state, tickets, compliances by status, QR codes, responsibilities and interventions attached to each equipment). - "actions-info": Projects `{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }`. - "updatable-fields": Per-field write rules for each equipment in its current state. - "responsibles": Adds `responsibles` - the users responsible for this element. - "created-by": Adds `createdBy` (the user who created each equipment). in: query name: extend required: false - schema: type: array items: type: object properties: field: type: string enum: - name - ref - createdAt - updatedAt 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. 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: anyOf: - type: boolean - type: string example: true in: query name: whereArchived required: false description: When `true`, only archived; when `false`, only non-archived. - 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 equipments 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 installations. - schema: type: array items: type: string example: - new - very_good in: query name: whereCondition required: false description: Filter by condition (matches any of the given codes). - schema: type: array items: type: string example: - in_service - in_stock in: query name: whereAvailability required: false description: Filter by availability (matches any of the given codes). - 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: whereInstalledBy required: false description: Filter by installer provider id. - schema: anyOf: - type: boolean - type: string example: true in: query name: wherePositioned required: false description: >- When `true`, only equipments with a position marker; when `false`, without. - 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: query name: whereCanBePositionedInPlan required: false description: >- Equipments belonging to the plan's unit that have no active plan position yet - feeds the plan's placement picker. - 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 equipments the current user is responsible for - holding a responsibility on the equipment, on its technical installation or on its unit. 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 equipments. 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 description: nullable: true type: string maxLength: 1000 manufacturer: nullable: true type: string minLength: 1 maxLength: 100 externalReference: nullable: true type: string minLength: 1 maxLength: 100 condition: nullable: true type: string enum: - new - very_good - good - average - bad availability: nullable: true type: string enum: - in_service - in_stock - in_repair - out_of_service purchasePrice: nullable: true type: number minimum: 0 exclusiveMinimum: true maximum: 999999999.99 replacementValue: nullable: true type: number minimum: 0 exclusiveMinimum: true maximum: 999999999.99 technicalInstallationId: 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)$ unitId: 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)$ installedById: 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)$ installedAt: nullable: true type: string format: date-time constructedAt: nullable: true type: string format: date-time 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 technicalInstallation: 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 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)$ 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 installedBy: 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 minLength: 1 maxLength: 150 required: - id - name additionalProperties: false position: 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)$ planId: 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)$ xPercent: type: number minimum: 0 maximum: 100 yPercent: type: number minimum: 0 maximum: 100 required: - id - planId - xPercent - yPercent additionalProperties: false containedIn: 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: 150 required: - id - name additionalProperties: false specifications: 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 specificationId: 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)$ specificationName: type: string minLength: 1 maxLength: 100 specificationColor: type: string pattern: ^#[0-9a-fA-F]{6}$ required: - id - name - specificationId - specificationName - specificationColor additionalProperties: false qrcode: 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)$ slug: type: string pattern: ^[A-Za-z0-9_-]{6,64}$ activatedAt: nullable: true type: string format: date-time required: - id - slug - activatedAt additionalProperties: false qrcodes: 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)$ slug: type: string pattern: ^[A-Za-z0-9_-]{6,64}$ number: type: integer minimum: 0 exclusiveMinimum: true maximum: 2147483647 activatedAt: nullable: true type: string format: date-time firstAssociationAt: nullable: true type: string format: date-time required: - id - slug - number - activatedAt - firstAssociationAt additionalProperties: false counts: type: object properties: anomalies: type: integer minimum: -9007199254740991 maximum: 9007199254740991 anomaliesToProcess: type: integer minimum: -9007199254740991 maximum: 9007199254740991 anomaliesInProgress: type: integer minimum: -9007199254740991 maximum: 9007199254740991 tickets: type: integer minimum: -9007199254740991 maximum: 9007199254740991 compliances: type: integer minimum: -9007199254740991 maximum: 9007199254740991 compliancesOverdue: type: integer minimum: -9007199254740991 maximum: 9007199254740991 compliancesAtRisk: type: integer minimum: -9007199254740991 maximum: 9007199254740991 compliancesOnTime: type: integer minimum: -9007199254740991 maximum: 9007199254740991 compliancesNotStarted: type: integer minimum: -9007199254740991 maximum: 9007199254740991 qrcodes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 responsibilities: type: integer minimum: -9007199254740991 maximum: 9007199254740991 interventions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - anomalies - anomaliesToProcess - anomaliesInProgress - tickets - compliances - compliancesOverdue - compliancesAtRisk - compliancesOnTime - compliancesNotStarted - qrcodes - responsibilities - interventions 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 description: type: boolean manufacturer: type: boolean externalReference: type: boolean condition: type: boolean availability: type: boolean purchasePrice: type: boolean replacementValue: type: boolean technicalInstallationId: type: boolean unitId: type: boolean installedById: type: boolean installedAt: type: boolean constructedAt: type: boolean containedIn: type: boolean specificationIds: type: boolean required: - name - description - manufacturer - externalReference - condition - availability - purchasePrice - replacementValue - technicalInstallationId - unitId - installedById - installedAt - constructedAt - containedIn - specificationIds 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 - description - manufacturer - externalReference - condition - availability - purchasePrice - replacementValue - technicalInstallationId - unitId - installedById - installedAt - constructedAt - 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 ````