> ## 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 device

> Full device record including the latest metrics snapshot. Use this after resolving an id from an event, alert, or CMDB record.

Requires a token with the `view.dashboard` scope.

Updated 23 Oct 2026 15:20 · page 3aa8e02


## OpenAPI

````yaml api-reference/openapi.json GET /pub/v1/devices/{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/devices/{id}:
    get:
      tags:
        - Devices
      summary: Get a device
      description: >-
        Full device record including the latest metrics snapshot. Use this after
        resolving an id from an event, alert, or CMDB record.


        Requires a token with the `view.dashboard` scope.
      parameters:
        - $ref: '#/components/parameters/DeviceIDPath'
      responses:
        '200':
          description: Device detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    DeviceIDPath:
      name: id
      in: path
      required: true
      description: Device id (UUID).
      schema:
        type: string
        format: uuid
  schemas:
    DeviceDetail:
      allOf:
        - $ref: '#/components/schemas/Device'
        - type: object
          properties:
            metrics:
              type: object
              additionalProperties: true
              description: Adapter-specific latest-known metrics. Shape varies by adapter.
    Device:
      type: object
      required:
        - id
        - name
        - type
        - protocol
        - status
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: >-
            The device's display name. Falls back to the adapter's reported id
            when no override is set in the portal.
        type:
          type: string
          description: >-
            Device category: `display`, `conferencing`, `audio`, `camera`,
            `control`, `avoip` (AV-over-IP), `power` or `projector`.
        protocol:
          type: string
          description: >-
            The adapter the Collector uses for the device, e.g. `sony_bravia`,
            `tesira`, `cisco_roomos`, `aten_pdu`.
        status:
          type: string
          enum:
            - online
            - offline
            - unknown
            - switched_off
          description: >-
            `unknown` when the device's Collector isn't reporting;
            `switched_off` while Room Readiness has it switched off for the
            night.
        ip_address:
          type: string
        make:
          type: string
        model:
          type: string
        serial_number:
          type: string
        firmware_version:
          type: string
          description: >-
            The device's firmware, as on the Firmware page: a `firmware_version`
            tag set in the portal, otherwise what the device last reported.
        target_firmware_version:
          type: string
          description: >-
            The target firmware set for the device's make and model on the
            Firmware page. Absent when none is set.
        firmware_status:
          type: string
          enum:
            - matches_target
            - differs_from_target
            - no_target
            - not_reported
          description: >-
            How the firmware compares with the target set for the device's make
            and model on the Firmware page: `matches_target`,
            `differs_from_target`, `no_target` (no target set) or `not_reported`
            (the device hasn't reported firmware).
        mac_address:
          type: string
        room_id:
          type: string
          format: uuid
        room:
          type: string
        building_id:
          type: string
          format: uuid
        building:
          type: string
        last_seen_at:
          type:
            - string
            - 'null'
          format: date-time
        tags:
          type: object
          additionalProperties:
            type: string
      example:
        id: 3f8b0f2c-1c1e-4c6b-9b2a-d0d9d4d1d3d4
        name: Boardroom display
        type: display
        protocol: sony_bravia
        status: online
        ip_address: 10.11.12.13
        make: Sony
        model: FW-65BZ40L
        serial_number: S01234567
        firmware_version: PKG6.6510
        target_firmware_version: PKG6.6510
        firmware_status: matches_target
        mac_address: '00:11:22:33:44:55'
        room_id: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
        room: Boardroom
        building_id: bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb
        building: HQ
        last_seen_at: '2026-08-26T09:14:03Z'
        tags:
          site: hq
          row: front
    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.