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

# Get a run with its steps

> One run with every step of its test routine, in order: what was checked, on which device, what was expected and what was found. Requires the `nightly.view` scope.

Updated 23 Oct 2026 15:20 · page 97a4fd3


## OpenAPI

````yaml api-reference/openapi.json GET /pub/v1/room-readiness/runs/{id}
openapi: 3.1.0
info:
  title: M.A.R.C.U.S. Public API
  version: 1.0.0
  summary: Programmatic access to a customer's AV fleet.
  description: >-
    Read-only integration API for the M.A.R.C.U.S. monitoring platform. Use it
    to sync device inventory into a CMDB, mirror alerts into an incident tool,
    or feed dashboards with live fleet state. Every route is scoped to the
    token's tenant — one token, one customer's data.


    Polling once a minute is ample for most use cases. Cursor-based pagination
    keeps list endpoints stable under concurrent inserts.
servers:
  - url: https://api.uat.involvecloud.com
    description: UAT
  - url: https://api.involvecloud.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: Health and identity of the calling token.
  - name: Devices
    description: >-
      AV endpoints under management — displays, cameras, DSPs, control
      processors.
  - name: Firmware
    description: >-
      Firmware versions across the fleet, against the targets set on the
      Firmware page. Needs the view.firmware scope.
  - name: Hierarchy
    description: 'Physical structure: buildings and rooms.'
  - name: Assets
    description: >-
      The CMDB inventory — every physical thing the tenant owns, monitored or
      not. Broader than Devices: includes mounts, cables, spares, retired gear.
  - name: Alerts
    description: Open + historical incidents raised on devices and collectors.
  - name: Events
    description: Device-emitted events — state changes, adapter messages, telemetry deltas.
  - name: Audit
    description: >-
      The tenant's audit trail of changes and commands. Needs the view.audit
      scope.
  - name: Room Readiness
    description: >-
      Results of each room's power schedule (switched off at night, on in the
      morning) and readiness checks (a test routine, down to every step). Needs
      the nightly.view scope.
paths:
  /pub/v1/room-readiness/runs/{id}:
    get:
      tags:
        - Room Readiness
      summary: Get a run with its steps
      description: >-
        One run with every step of its test routine, in order: what was checked,
        on which device, what was expected and what was found. Requires the
        `nightly.view` scope.
      parameters:
        - name: id
          in: path
          required: true
          description: Run id (UUID).
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The run and its steps.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessRunDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ReadinessRunDetail:
      allOf:
        - $ref: '#/components/schemas/ReadinessRun'
        - type: object
          required:
            - steps
          properties:
            steps:
              type: array
              items:
                $ref: '#/components/schemas/ReadinessStep'
    ReadinessRun:
      type: object
      required:
        - id
        - kind
        - room_id
        - room
        - building_id
        - building
        - status
        - phase
        - scheduled_at
        - steps_total
        - steps_passed
        - steps_failed
      properties:
        id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
            - power
            - readiness
          description: >-
            `power`: the room switched off at night and back on. `readiness`: a
            test routine.
        room_id:
          type: string
          format: uuid
        room:
          type: string
        building_id:
          type: string
          format: uuid
        building:
          type: string
        routine_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The test routine the run used; null for a power-cycle-only run.
        routine:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending
            - in_progress
            - succeeded
            - failed
            - skipped
        phase:
          type: string
          enum:
            - pending
            - scheduled_off
            - 'off'
            - scheduled_on
            - waking
            - warming
            - testing
            - ready
            - failed
          description: How far the run got. `ready` means the room passed.
        scheduled_at:
          type: string
          format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the run began: the evening power-off, or the start of a run
            without a power cycle.
        powered_on_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the morning power-on began; null until then, and for runs
            without a power cycle.
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        duration_seconds:
          type:
            - integer
            - 'null'
          description: >-
            How long the room took to be ready (or to fail) after power-on; for
            a run without a power cycle, from its start.
        failure_reason:
          type:
            - string
            - 'null'
        steps_total:
          type: integer
          description: >-
            Steps recorded so far, including the scheduled power off and power
            on.
        steps_passed:
          type: integer
        steps_failed:
          type: integer
    ReadinessStep:
      type: object
      required:
        - index
        - name
        - type
        - passed
      properties:
        index:
          type: integer
          description: >-
            Position in the routine, from 0. The scheduled power off and power
            on come first, as -2 and -1.
        name:
          type: string
        type:
          type: string
          description: >-
            e.g. `power_off`, `power_on`, `wait`, `expect_status`,
            `check_metric`, `ping`, `device_command`.
        device_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Null for steps that aren't about one device.
        device:
          type:
            - string
            - 'null'
        passed:
          type: boolean
        expected:
          description: What the step checked for, as configured in the routine.
        actual:
          description: What the step found.
        readings:
          type:
            - array
            - 'null'
          description: >-
            Check steps only: for each device judged, where its reading came
            from. `fresh` is a poll made for the step; `last_report` is the
            device's last regular report (an ATEN PDU, or a fresh poll that
            didn't come back within 60 seconds); `none` means there was no
            reading. Null for other steps and for runs before readings were
            recorded.
          items:
            type: object
            required:
              - device
              - source
            properties:
              device:
                type: string
              source:
                type: string
                enum:
                  - fresh
                  - last_report
                  - none
              at:
                type: string
                format: date-time
                description: When the reading was taken.
              age_s:
                type: integer
                description: How old the reading was when the step judged it, in seconds.
        error:
          type:
            - string
            - 'null'
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - code
          properties:
            message:
              type: string
              description: Human-readable summary. Not intended for parsing.
            code:
              type: string
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - internal_error
                - error
              description: Stable machine-readable identifier.
      example:
        error:
          message: 'token missing scope: view.dashboard'
          code: forbidden
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or expired bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token authenticated but doesn't hold the scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource missing or invisible to this token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: avb_<prefix>_<secret>
      description: >-
        Mint a token from the portal at Settings → API tokens. Send it as
        `Authorization: Bearer avb_...` on every request. Query-string tokens
        are NOT accepted — the URL ends up in access logs.

````

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