Use the TeamViewer API - TeamViewer Support
<main> <article class="userContent"> <p><br></p><h3></h3><h2 data-id="general">General</h2><div class="blockquote"><div class="blockquote-content"><p class="blockquote-line">This article applies to all TeamViewer users.</p></div></div><p>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.</p><p>The <a href="https://en.wikipedia.org/wiki/Web_API" rel="nofollow noreferrer ugc">API</a> uses <a href="https://en.wikipedia.org/wiki/Representational_state_transfer" rel="nofollow noreferrer ugc">REST</a> to communicate with your application and the secure authorization standard OAuth 2.0 to manage access to all data.</p><p><br></p><h3 data-id="-1"></h3><h2 data-id="features">Features</h2><p>The TeamViewer API for application developers provides access to the following TeamViewer functionality:</p><ul><li><strong>User Management</strong></li><li><strong>Group Management</strong></li><li><strong>Session Management</strong></li><li><strong>Connection reports</strong></li><li><strong>Online Meetings</strong></li><li><strong>Computers & Contacts</strong></li><li><strong>Web Monitoring</strong></li><li><strong>Monitoring and Patch Management</strong></li></ul><p><br></p><h3 data-id="-2"></h3><h2 data-id="create-a-script-token">Create a script token</h2><p>To use the TeamViewer API, you need to create a script token.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6032394/uploads/QR21RC7YHA9F/create-script-token-final.gif" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/QR21RC7YHA9F/create-script-token-final.gif" alt="Create script token_final.gif" height="1172" width="1922" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>1) Log in to the <strong>Management Console</strong>: <a href="https://login.teamviewer.com/" rel="nofollow noreferrer ugc">https://login.teamviewer.com/</a></p><p>2) <strong>Click on your user</strong> in the upper right corner and select <strong>Edit profile</strong></p><p>3) Select <strong>Apps</strong></p><p>4) Select <strong>Create script token</strong></p><p>5) <strong>Tick</strong> all <strong>the permissions</strong> you need for your token</p><p>⚠ <strong>Important note: </strong>Please tick only the permissions that are relevant for your use case, as a token with unwanted permissions could cause unwanted effects.</p><p>6) Select <strong>Create</strong></p><p>📌<strong>Note:</strong> Please keep in mind that once the token has been created, it cannot be edited. It can only be deleted.</p><p>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.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6032394/uploads/NUM8DQG8K13D/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/NUM8DQG8K13D/image.png" alt="image.png" height="436" width="1101" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><br></p><h3 data-id="-3"></h3><h2 data-id="use-the-api">Use the API</h2><p>You will find the list of all calls you can use and more information about the TeamViewer API here:</p><ul><li><a href="https://webapi.teamviewer.com/api/v1/docs/index#/" rel="nofollow noreferrer ugc">https://webapi.teamviewer.com/api/v1/docs/index#/</a></li><li><a href="https://dl.teamviewer.com/integrate/TeamViewer_API_Documentation.pdf" rel="nofollow noreferrer ugc">TeamViewer API Documentation</a></li></ul><p>You will also find all the pre-built scripts on GitHub:</p><ul><li><a href="https://github.com/TeamViewer/TeamViewerPS" rel="nofollow noreferrer ugc">GitHub - TeamViewer/TeamViewerPS</a></li><li><a href="https://github.com/teamviewer/TeamViewerPS/blob/main/docs/about_TeamViewerPS.md" rel="nofollow noreferrer ugc">GitHub - About TeamViewer PS</a></li><li><a href="https://github.com/teamviewer/api-example-scripts" rel="nofollow noreferrer ugc">GitHub - Scripts Examples</a></li></ul><p><br></p> </article> </main>
