> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shared-desk.pedda.digital/llms.txt
> Use this file to discover all available pages before exploring further.

# Get equipment

> Retrieves equipment details by its ID



## OpenAPI

````yaml get /api/equipment/{id}
openapi: 3.0.1
info:
  title: Shared Desk System
  description: OpenApi documentation for Shared Desk System
  version: '1.0'
servers:
  - url: http://localhost
    description: Local Cors
  - url: http://localhost:8080
    description: Local
  - url: https://production.shared-desk.cloud
    description: Production
  - url: https://staging.shared-desk.cloud
    description: Staging
security:
  - bearerAuth: []
  - cookieAuth: []
tags:
  - name: Stats
    description: Endpoints for retrieving statistics
  - name: User
    description: Endpoints for managing users
  - name: Password
    description: API for password reset
  - name: Authentication
    description: API for authentication
  - name: Search
    description: >-
      Advanced search operations. Allows to search for departments, rooms and
      desks.
  - name: Department
    description: API for department management
  - name: Equipment
    description: Endpoints for managing equipment
  - name: Desk
    description: API for desk management
  - name: Actuator
    description: Monitor and interact
    externalDocs:
      description: Spring Boot Actuator Web API Documentation
      url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
  - name: Room
    description: API for room management
  - name: Session
    description: Endpoints for managing user sessions
externalDocs:
  description: Public Service Documentation
  url: https://docs.shared-desk.cloud/api/introduction
paths:
  /api/equipment/{id}:
    get:
      tags:
        - Equipment
      summary: Get equipment
      description: Retrieves equipment details by its ID
      operationId: getEquipmentById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Equipment successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EquipmentResponseDTO'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Bad credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                BadCredentialsExample:
                  description: BadCredentialsExample
                  value:
                    status: 401
                    error: Unauthorized
                    message: Full authentication is required to access this resource
                    details: []
                    path: /
                    timestamp: '2024-05-29T12:34:56'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ForbiddenExample:
                  description: ForbiddenExample
                  value:
                    status: 403
                    error: Forbidden
                    message: Access denied
                    details: []
                    path: /api/
                    timestamp: '2024-05-29T12:34:56'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                EquipmentNotFoundExample:
                  description: EquipmentNotFoundExample
                  value:
                    status: 404
                    error: Not Found
                    message: Equipment not found
                    details: []
                    path: /api/equipment/{id}
                    timestamp: '2024-06-04T12:34:56'
components:
  schemas:
    EquipmentResponseDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        type:
          type: string
          enum:
            - DOCKING_STATION
            - MONITOR
            - KEYBOARD
            - MOUSE
            - OTHER
    ApiError:
      type: object
      properties:
        timestamp:
          type: string
          example: '2024-05-29T12:34:56'
        status:
          type: integer
          format: int32
        error:
          type: string
        message:
          type: string
        details:
          type: array
          example: []
          items:
            type: object
            example: []
        path:
          type: string
          example: /api/?
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    cookieAuth:
      type: apiKey
      name: Authorization
      in: cookie

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.