Modernizing the Fitbit Developer Experience.
The Fitbit Web APIs are moving to a new, scalable infrastructure. We will be deprecating the legacy Fitbit Web API in September 2026. To ensure uninterrupted data continuity for your users, you will need to migrate your applications. Detailed migration guides are live on the Google Health API developer site.
Host API
chevron down
 

Host API

Interface: Host

Host API Information about the environment in which the companion runs

import { me as companion } from "companion"

console.log(`App Name: ${companion.host.app.name}`);
console.log(`App Version: ${companion.host.app.version}`);

console.log(`OS Name: ${companion.host.os.name}`);
console.log(`OS Version: ${companion.host.os.version}`);

Properties

readonly app

{ readonly name: string; readonly version: string; }

readonly os

{ readonly name: "Android" or "iOS" or "Windows"; readonly version: string; }