TeamViewer provides a web-based API that allows you to access data and control various aspects of your TeamViewer account. You can use the API to develop apps that integrate TeamViewer functionality into your corporate environment or develop apps that everyone can use.

The API uses REST to communicate with your application and the secure authorization standard OAuth 2.0 to manage access to all data.

This article applies to all TeamViewer customers with a Business, Premium, Corporate or Tensor plan.

Features

The TeamViewer API for application developers provides access to the following TeamViewer functionality:

  • User Management
  • Group Management
  • Session Management
  • Connection reports
  • Online Meetings
  • Computers & Contacts
  • Web Monitoring
  • Monitoring and Patch Management

Create a script token

To use the TeamViewer API, you need to create a script token.

  1. Log in to the Management Console: https://login.teamviewer.com/.
  2. Click on your user in the upper right corner and select Edit profile.
  3. Select Apps.
  4. Select Create script token.
  5. Tick all the permissions you need for your token.
    • Important note: Please tick only the permissions that are relevant for your use case, as a token with unwanted permissions could cause unwanted effects.
  6. Select Create.
    • 📌Note: Please keep in mind that once the token has been created, it cannot be edited. It can only be deleted.
  7. The token has now been added to the Apps and Scripts list. To get your token, click on the newly created token. The token will be displayed under the token name.

Use the API

You will find the list of all calls you can use and more information about the TeamViewer API here:

You will also find all the pre-built scripts on GitHub: