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

# Get the live status of a shower

> Asks the shower for its status and waits up to 5 seconds for it to answer; online is false if it doesn't, or right away if the shower is known to be offline. state is what the shower is doing, e.g. ready, starting, showering, paused or hibernating. temperature_setpoint is in °C.




## OpenAPI

````yaml /spec.json get /client/showers/{id}/status
openapi: 3.0.4
info:
  title: Orbital API
  version: 1.0.0
  description: >-
    Send your API key in the `x-api-key` header of every request. The key
    belongs to one Orbital account, and requests act as that account: they see
    and control only the devices it owns or has been given access to. A missing
    or unknown key gets `403` with `{ "message": "Forbidden" }`.
servers:
  - url: https://api.orbital-systems.com
    description: Production
  - url: https://stage-api.orbital-systems.com
    description: Staging
  - url: https://dev-api.orbital-systems.com
    description: Development
security:
  - apiKeyAuth: []
tags: []
paths:
  /client/showers/{id}/status:
    get:
      tags:
        - Shower commands.
      summary: Get the live status of a shower
      description: >
        Asks the shower for its status and waits up to 5 seconds for it to
        answer; online is false if it doesn't, or right away if the shower is
        known to be offline. state is what the shower is doing, e.g. ready,
        starting, showering, paused or hibernating. temperature_setpoint is in
        °C.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: The unique identifier for the shower
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/showerStatusResponse'
        '403':
          description: You don’t have access to the shower
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Forbidden
                statusCode: 403
                name: ForbiddenError
        '404':
          description: Shower not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Shower not found
                statusCode: 404
                name: NotFoundError
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Internal server error
components:
  schemas:
    showerStatusResponse:
      type: object
      properties:
        online:
          type: boolean
          description: Whether the shower answered within 5 seconds.
          example: true
        state:
          type: string
          nullable: true
          description: >-
            What the shower is doing, such as `ready`, `starting`, `showering`,
            `paused`, `cleaning` or `hibernating`. `null` when it didn’t answer.
          example: showering
        temperature_setpoint:
          type: number
          nullable: true
          description: >-
            Current temperature setpoint, in °C. `null` when the shower didn’t
            answer.
          example: 38
        flow_setpoint:
          type: number
          nullable: true
          description: >-
            Current flow setpoint, in L/min. `null` when the shower didn’t
            answer.
          example: 9
      required:
        - online
    error:
      type: object
      description: Returned with every 4xx and 5xx response.
      required:
        - message
      properties:
        message:
          type: string
          description: What went wrong.
        name:
          type: string
          description: Kind of error. Not set on a `500`.
        statusCode:
          type: integer
          description: HTTP status code, repeated from the response. Not set on a `500`.
        code:
          type: integer
          enum:
            - 1
            - 2
          description: >-
            Set on a `403` from pairing a device someone else owns: `1` the
            owner doesn’t accept sharing requests, `2` a sharing request was
            sent to the owner.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Send your API key in the `x-api-key` header of every request. The key
        belongs to one Orbital account, and requests act as that account: they
        see and control only the devices it owns or has been given access to. A
        missing or unknown key gets `403` with `{ "message": "Forbidden" }`.

````

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