Support for the legacy Fitbit Web API ends on September 30, 2026
Important: Support for the legacy Fitbit Web API ends on September 30, 2026. After this date the API will continue to operate, but Google will no longer fix bugs or provide API support. On October 30, 2026, the Fitbit Web API will be turned off and will no longer function or sync data to or from Fitbit users. To continue accessing data for your users after this date, migrate to the Google Health API.
Companion API
chevron down
 

Companion API

Variable: me

Type: Companion

The Companion API provides information about the running companion application, access to permissions, and oAuth access tokens.

import { me } from "companion";
console.log("Application ID: " + me.applicationId);
if (!me.permissions.granted("access_internet")) {
   console.log("We're not allowed to access the internet :-(");
}

Interface: Companion

The Companion interface provides information about the running companion application, access to permissions, environment information and oAuth access tokens.

Properties

readonly applicationId

string

Application identifier under which the current application is running.

readonly buildId

string

Application build identifier under which the current application is running.

readonly host

Host

Information about the environment in which the companion runs

readonly permissions

Permissions

Permissions that have been granted or denied to the application.