Develop

Get started

Get started and develop an app or script. TeamViewer API uses OAuth 2.0 and Script tokens as well as Client IDs.

Start developing right now

Developing your own application is easy. Follow the steps below or jump right into the API documentation to get started right away.

In the TeamViewer API, two different ways of using the API are distinguished: Either through Scripts or through Apps.

Apps are developed to be used by many different accounts. Because of this, Scripts and Apps have different ways of accessing TeamViewer data, represented by different types of tokens.

If you want to use the API for your own data only, create a script token. Don’t worry if you change your mind later, you can still migrate to an App with ease. If you want to create an App to be used by other TeamViewer customers, go ahead and create an OAuth 2.0 Client ID.





Create account

You need a TeamViewer account to use the TeamViewer API.

The easiest why to do so, is to visit the TeamViewer Management Console website. Sign up for an account at the left site of the page.

Create a TeamViewer account in the TeamViewer Management Console to develop a TeamViewer app or script with the TeamViewer API | Screenshot

Create script

Open your profile settings in the TeamViewer Management Console | Screenshot

Open Management Console

To create a script, you have to log in to the TeamViewer Management Console with your TeamViewer account.

In the Console, open your profile settings in the top right of the website.

Create script

  1. Enter your script name
  2. Enter a description for your script
  3. Choose the permissions of your script
  4. Save the script



Please find further information in the API documentation.

Create a new script that can be used with your own TeamViewer account | Screenshot
Write down the script token from the script’s properties. You will need it later | Screenshot

Write down Token

Write down the Token from the properties of the script you created recently.
You will need the Token in the developing process.

Please find more information about the Token in the API documentation

Start coding

You can now start writing your own script using the
API documentation or you can use your token in one of our example scripts.

Create application

Open the Apps menu in the TeamViewer Management Console | Screenshot

Open console

To create an application, log in to the TeamViewer Management Console with your TeamViewer account.

In the Console, open the Apps link in the footer of the website.

Create app

  1. Enter an application name
  2. Enter a description for your application
  3. Enter the Redirect URI.
    Users are redirected to the URI after granting your application access to their data. If set, only authorization requests will be granted that use the given Redirect URI. Can be changed later.
  4. Choose an access level
  5. Choose the permissions of your app
  6. Save the app



Please find further information in the API documentation.

Create a new app that can be used with any TeamViewer account using the methods of OAuth 2.0 | Screenshot
Write down the Client ID from the script’s properties. You will need it later | Screenshot

Write down Client ID and Client secret

Write down the Client ID and the Client secret from the properties of the app you created recently.
You will need them in the developing process.

Please find more information about the Client ID in the API documentation.

Start coding

You can now start writing your own application using the
API documentation.