TeamViewer Connector

Source API Docs API Changelog Connector Changelog

Description

TeamViewer is support software that allows users to connect to and control devices remotely for troubleshooting, collaboration, and management purposes.

Use the component to manage your devices, groups, contacts, patches, and more.

API Documentation

The TeamViewer component was built using the TeamViewer WEB API

Connections

OAuth 2.0

key: teamviewer-oauth

To Create an OAuth app in Teamviewer:

Login to your TeamViewer account.
In the top right corner select your user icon and select Edit profile.
Navigate to Apps and Select Create App.
In the Redirect URL field enter https://oauth2.prismatic.io/callback.
Ensure the app has sufficient permissions for an integration and select Create upon completion.
Save and copy the Client ID and Client Secret and enter them into the connection configuration of your integration.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for TeamViewer	https://login.teamviewer.com/oauth2/authorize?display=popup
Client ID	Client ID for the TeamViewer OAuth 2.0 connection
Client Secret	Client Secret for the TeamViewer OAuth 2.0 connection
Scopes	TeamViewer Scopes.
Token URL	The OAuth 2.0 Token URL for TeamViewer	https://webapi.teamviewer.com/api/v1/oauth2/token

Triggers

New Records

Checks for new devices, users, or groups in TeamViewer on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection
Resource Type	The type of resource to poll for new records.
Show New Records	Include newly detected records in the trigger output.	true

This trigger polls the TeamViewer Web API for new records on a scheduled basis.

How It Works

The trigger runs on the configured schedule
It fetches records from TeamViewer and compares them against the set of known record IDs stored from the previous poll
Records whose IDs were not present in the previous poll are classified as created
The trigger updates its internal state after each poll

Configuration

Configure the following inputs:

Connection: The TeamViewer connection used to authenticate API requests
Resource Type: The type of TeamViewer record to monitor

Resource Tracks New Tracks Updated
Devices Yes No
Users Yes No
Groups Yes No
Show New Records: When enabled, includes newly created records in the results. Defaults to true

Resource	Tracks New	Tracks Updated
Devices	Yes	No
Users	Yes	No
Groups	Yes	No

Returned Data

Returns an object with two arrays — created for new records and updated for modified records.

Example Response

{
  "data": {
    "created": [
      {
        "device_id": "d123456789",
        "alias": "Workstation-07",
        "groupid": "g112233",
        "online_state": "Online"
      }
    ],
    "updated": []
  }
}

Notes

The first poll establishes a baseline by recording all current record IDs. No records are returned on the first execution — subsequent polls detect newly added records by comparing against this baseline
Update detection is not supported for any resource type. Only new records are surfaced

Data Sources

Select Contact

Select a contact from a dropdown menu. | key: selectContact | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Contact⤓

Loading…

Select Device

Select a device from a dropdown menu. | key: selectDevice | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Device⤓

Loading…

Select Group

Select a group from a dropdown menu. | key: selectGroup | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Group⤓

Loading…

Select Managed Device

Select a managed device from a dropdown menu. | key: selectManagedDevice | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Managed Device⤓

Loading…

Select Policy

Select a TeamViewer policy from a dropdown menu. | key: selectPolicy | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Policy⤓

Loading…

Select Session

Select a session from a dropdown menu. | key: selectSession | type: picklist

Input	Notes	Example
Connection

Example Payload for Select Session⤓

Loading…

Select User

Select a user from a dropdown menu. | key: selectUser | type: picklist

Input	Notes	Example
Connection

Example Payload for Select User⤓

Loading…

Select User Role

Select a user role from a dropdown menu. | key: selectUserRole | type: picklist

Input	Notes	Example
Connection

Example Payload for Select User Role⤓

Loading…

Actions

Assign Device

Assigns a device to a user account. | key: assignDevice

Input	Notes	Example
Assignment Options	Options controlling how the device is assigned, including the current password, easy access, and assign mode.
Connection
Device ID	The ID of the device to retrieve.	123456

Example Payload for Assign Device⤓

Loading…

Create Account

Creates a new account. | key: createAccount

Input	Notes	Example
Client ID	The client ID associated with your TeamViewer account.	123456
Client Secret	The client secret associated with your TeamViewer account.	yourclientsecret
Connection
Email	The email address associated with your TeamViewer account.	test@test.com
Language	The language of the account holder.	en
Name	The name of the account holder.	John Doe
Password	The password associated with your TeamViewer account.	password

Example Payload for Create Account⤓

Loading…

Create Contact

Creates a new contact. | key: createContact

Input	Notes	Example
Connection
Description	The description of the contact.	This is my contact.
Email	The email of the contact.	test@test.com
Group ID	The ID of the group to which the contact belongs. Either groupid or groupName is required.	g3370655
Group Name	The name of the group to which the contact belongs. Either groupid or groupName is required.	My Group
Invite	Whether to invite the contact to TeamViewer.	false
Name	The name of the contact.	John Doe

Example Payload for Create Contact⤓

Loading…

Create Device

Creates a new device. | key: createDevice

Input	Notes	Example
Alias	The alias of the device.	My Device
Connection
Description	The description of the device.	This is my device.
Group ID	The ID of the group to which the device belongs.	g3370655
Password	The password of the device.	password
Remote Control ID	The ID of the remote control to assign to the device.	123456

Example Payload for Create Device⤓

Loading…

Create Group

Creates a new group. | key: createGroup

Input	Notes	Example
Connection
Name	The name of the group.	My Group
Policy ID	The policy ID of the group.	123456

Example Payload for Create Group⤓

Loading…

Create Session

Creates a new session. | key: createSession

Input	Notes	Example
Connection
Body	Custom fields to include in the request body.
Custom ID	The custom ID of the session.	123456
Description	The description of the session.	This is my session.
Group	Group ID or group name the record belongs to.

Example Payload for Create Session⤓

Loading…

Create User

Creates a user. | key: createUser

Input	Notes	Example
Additional Fields	Secondary account preference settings for the new user, including newsletter subscription, session logging, comment window display, and predefined role override.
Connection
Custom Quick Join ID	Custom Quick Join ID of the user	<your_custom_quick_join_id>
Custom Quick Support ID	Custom Quick Support ID of the user	<your_custom_quick_support_id>
User Email	User email to query from.	example@company.io
User Language	User language.	en
License	License and meeting license keys.
User Name	User name to query from.	example_user
User Password	User password.
SSO Customer ID	SSO Customer ID of the user	<your_sso_customer_id>
User Role ID	The ID of the user role to assign to the user.	<your-user-role-id>

Example Payload for Create User⤓

Loading…

Delete Contact

Deletes a contact by its ID. | key: deleteContact

Input	Notes	Example
Connection
Contacts ID	The ID of the contact to delete.	123456

Example Payload for Delete Contact⤓

Loading…

Delete Device

Deletes a device by its ID. | key: deleteDevice

Input	Notes	Example
Connection
Device ID	The ID of the device to delete.	123456

Example Payload for Delete Device⤓

Loading…

Delete Group

Deletes a group by its ID. | key: deleteGroup

Input	Notes	Example
Connection
Group ID	The ID of the group to delete.	123456

Example Payload for Delete Group⤓

Loading…

Delete Managed Device

Deletes a managed device by its ID. | key: deleteManagedDevice

Input	Notes	Example
Connection
Managed Device ID	The ID of the managed device to delete.	123456

Example Payload for Delete Managed Device⤓

Loading…

Delete User

Deletes a user. | key: deleteUser

Input	Notes	Example
Connection
Permanent Delete	Whether to permanently delete the user or just deactivate them.	false
User ID	The ID of the user to retrieve.	<your-user-id>

Example Payload for Delete User⤓

Loading…

Delete User Company

Deletes the company of account (user) that is associated with the used API token. This account should be the last user with admin rights at the company. | key: deleteUserCompany

Input	Notes	Example
Connection

Example Payload for Delete User Company⤓

Loading…

Get Account

Returns the account that is associated with the used API token. | key: getAccount

Input	Notes	Example
Connection

Example Payload for Get Account⤓

Loading…

Get Account Tenant IDs

Returns the account's tenant IDs. | key: getAccountTenantIds

Input	Notes	Example
Connection

Example Payload for Get Account Tenant IDs⤓

Loading…

Get Contact

Returns a contact by its ID. | key: getContact

Input	Notes	Example
Connection
Contacts ID	The ID of the contact to retrieve.	123456

Example Payload for Get Contact⤓

Loading…

Get Device

Returns a device by its ID. | key: getDevice

Input	Notes	Example
Connection
Device ID	The ID of the device to retrieve.	123456

Example Payload for Get Device⤓

Loading…

Get Group

Returns a group by its ID. | key: getGroup

Input	Notes	Example
Connection
Group ID	The ID of the group to retrieve.	123456

Example Payload for Get Group⤓

Loading…

Get Managed Device

Returns a managed device by its ID. | key: getManagedDevice

Input	Notes	Example
Connection
Managed Device ID	The ID of the managed device to retrieve.	123456

Example Payload for Get Managed Device⤓

Loading…

Get Missing Patches

This request will return all missing patches on the device, which id is provided in the request. | key: getMissingPatches

Input	Notes	Example
Connection
Device ID	The ID of the device to retrieve missing patches for.	123456

Example Payload for Get Missing Patches⤓

Loading…

Get Ping

Returns if the current token is valid. | key: getPing

Input	Notes	Example
Connection

Example Payload for Get Ping⤓

Loading…

Get Session

Returns a session by its ID. | key: getSession

Input	Notes	Example
Connection
Session ID	The ID of the session to retrieve.	123456

Example Payload for Get Session⤓

Loading…

Get User

Retrieves the user associated with the used API token. | key: getUser

Input	Notes	Example
Connection
User ID	The ID of the user to retrieve.	<your-user-id>

Example Payload for Get User⤓

Loading…

List Company Managed Devices

Lists one page of company-managed devices of the company that is associated with the currently logged-in session. | key: listCompanyManagedDevices

Input	Notes	Example
Connection
Fetch All	Whether to fetch all records or just the first page.	false
Pagination Token	To fetch the next batch of result items, provide the value received as 'nextPaginationToken' from the previous call. Will fetch the first page if not given.	paginationToken123
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Company Managed Devices⤓

Loading…

List Contacts

Returns a list of contacts. | key: listContacts

Input	Notes	Example
Connection
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Contacts⤓

Loading…

List Devices

Returns a list of devices. | key: listDevices

Input	Notes	Example
Connection
Group ID	The ID of the group to which the device belongs.	g3370655
Name	The name of the device.	My Device
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2
Remote Control ID	The ID of the remote control to assign to the device.	123456

Example Payload for List Devices⤓

Loading…

List Groups

Returns a list of groups. | key: listGroups

Input	Notes	Example
Connection
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Groups⤓

Loading…

List Managed Devices

Returns a list of managed devices. | key: listManagedDevices

Input	Notes	Example
Connection
Fetch All	Whether to fetch all records or just the first page.	false
Pagination Token	To fetch the next batch of result items, provide the value received as 'nextPaginationToken' from the previous call. Will fetch the first page if not given.	paginationToken123
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Managed Devices⤓

Loading…

List Patch Management Device

Returns a list of patch management devices. | key: listPatchMagementDevices

Input	Notes	Example
Connection
Continuation Token	The continuation token from the previous response.	123456
Fetch All	Whether to fetch all records or just the first page.	false
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Patch Management Device⤓

Loading…

List Sessions

Returns a list of sessions. | key: listSessions

Input	Notes	Example
Connection
Query Parameters	The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Sessions⤓

Loading…

List Users

Retrieves all users with given filter criteria. | key: listUsers

Input	Notes	Example
Connection
Full List	Is detailed user information needed	false
User Permissions	Comma separated access rights. Please use user role APIs for user's rights.	ADMIN, USER
User Email	User email to query from.	example@company.io
User Name	User name to query from.	example_user

Example Payload for List Users⤓

Loading…

Raw Request

Send raw HTTP request to Teamviewer API | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/contacts), The base URL is already included (https://webapi.teamviewer.com/api/v1/). For example, to connect to https://webapi.teamviewer.com/api/v1/contacts, only /contacts is entered in this field. e.g. /contacts	/contacts
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Scan Results Count

Retrieves the number of scan results for the specified devices. | key: scanResultsCount

Input	Notes	Example
Connection
Continuation Token	The continuation token from the previous response.	123456
Device ID List	A list of device IDs to retrieve missing patches for.	`[ 13456, 12345 ]`

Example Payload for Scan Results Count⤓

Loading…

Update Account

Updates an account. | key: updateAccount

Input	Notes	Example
Connection
Email	The email address associated with your TeamViewer account.	test@test.com
Email Language	The language of the account holder.	en
Name	The name of the account holder.	John Doe
Old Password	The current password associated with your TeamViewer account.	password
Password	The password associated with your TeamViewer account.	password

Example Payload for Update Account⤓

Loading…

Update Device

Updates a device by its ID. | key: updateDevice

Input	Notes	Example
Alias	The alias of the device.	My Device
Connection
Description	The description of the device.	This is my device.
Device ID	The ID of the device to retrieve.	123456
Group ID	The ID of the group to which the device belongs.	g3370655
Password	The password of the device.	password
Remote Control ID	The ID of the remote control to assign to the device.	123456

Example Payload for Update Device⤓

Loading…

Update Group

Updates an existing group by its ID. | key: updateGroup

Input	Notes	Example
Connection
Group ID	The ID of the group to update.	123456
Name	The name of the group.	My Group
Policy ID	The policy ID of the group.	123456

Example Payload for Update Group⤓

Loading…

Update Managed Device

Modify the attributes of a managed device using its designated 'id.' You can provide the device's 'name' (alias) to enact changes, provide a 'teamviewerPolicyId' to update or add a TeamViewer policy, or provide a 'managedGroupId' to inherit the TeamViewer Policy from a managed group to which the device is associated. | key: updateManagedDevice

Input	Notes	Example
Connection
Managed Device ID	The ID of the managed device to retrieve.	123456
Managed Group ID	The ID of the managed group to associate with the managed device.	123456
Name	The name of the managed device.	My Device
TeamViewer Policy ID	The TeamViewer policy ID of the managed device.	123456

Example Payload for Update Managed Device⤓

Loading…

Update Session

Updates a session by its ID. | key: updateSession

Input	Notes	Example
Connection
Body	Custom fields to include in the request body.
Custom ID	The custom ID of the session.	123456
Description	The description of the session.	This is my session.
Group	Group ID or group name the record belongs to.
Session ID	The ID of the session to retrieve.	123456

Example Payload for Update Session⤓

Loading…

Update User

Updates a user. | key: updateUser

Input	Notes	Example
Additional Fields	Secondary settings for the user, including activation status, session logging, comment window display, license key, and TFA enforcement.
Assign User Role IDs	Comma separated list of user role IDs to assign to the user.	`["<your-user-role-id>","<your-user-role-id>","<your-user-role-id>"]`
Connection
Custom Quick Join ID	Custom Quick Join ID of the user	<your_custom_quick_join_id>
Custom Quick Support ID	Custom Quick Support ID of the user	<your_custom_quick_support_id>
User Email	User email to query from.	example@company.io
User Name	User name to query from.	example_user
User Password	User password.
SSO Customer ID	SSO Customer ID of the user	<your_sso_customer_id>
Unassign User Role IDs	Comma separated list of user role IDs to unassign to the user.	`["<your-user-role-id>","<your-user-role-id>","<your-user-role-id>"]`
User ID	The ID of the user to retrieve.	<your-user-id>

Example Payload for Update User⤓

Loading…

Changelog

2026-07-21

Restructured action inputs into structured objects for an improved user experience.

Create Contact, Create Session, and Update Session group their related inputs into a Group structured object
Create User groups related inputs into License and Additional Fields structured objects
Update User groups optional settings into an Additional Fields structured object
Assign Device groups Current Password, Enable Easy Access, and Assign Mode into an Assignment Options structured object

2026-04-30

Updated spectral version

2026-04-21

Added New Records polling trigger that checks for new devices, users, or groups in TeamViewer on a configured schedule, using ID-based change detection

2026-04-10

Updated Example Payloads

2026-02-26

Added inline data source for sessions to enable dynamic dropdown selection

2025-08-15

Added data sources and inline data sources for contacts, policies, users, and user roles to enhance data selection capabilities

TeamViewer Connector

Description​

API Documentation​

Connections​

OAuth 2.0​

Triggers​

New Records​

How It Works​

Configuration​

Returned Data​

Notes​

Data Sources​

Select Contact​

Select Device​

Select Group​

Select Managed Device​

Select Policy​

Select Session​

Select User​

Select User Role​

Actions​

Assign Device​

Create Account​

Create Contact​

Create Device​

Create Group​

Create Session​

Create User​

Delete Contact​

Delete Device​

Delete Group​

Delete Managed Device​

Delete User​

Delete User Company​

Get Account​

Get Account Tenant IDs​

Get Contact​

Get Device​

Get Group​

Get Managed Device​

Get Missing Patches​

Get Ping​

Get Session​

Get User​

List Company Managed Devices​

List Contacts​

List Devices​

List Groups​

List Managed Devices​

List Patch Management Device​

List Sessions​

List Users​

Raw Request​

Scan Results Count​

Update Account​

Update Device​

Update Group​

Update Managed Device​

Update Session​

Update User​

Changelog​

2026-07-21​

2026-04-30​

2026-04-21​

2026-04-10​

2026-02-26​

2025-08-15​

Description

API Documentation

Connections

OAuth 2.0

Triggers

New Records

How It Works

Configuration

Returned Data

Notes

Data Sources

Select Contact

Select Device

Select Group

Select Managed Device

Select Policy

Select Session

Select User

Select User Role

Actions

Assign Device

Create Account

Create Contact

Create Device

Create Group

Create Session

Create User

Delete Contact

Delete Device

Delete Group

Delete Managed Device

Delete User

Delete User Company

Get Account

Get Account Tenant IDs

Get Contact

Get Device

Get Group

Get Managed Device

Get Missing Patches

Get Ping

Get Session

Get User

List Company Managed Devices

List Contacts

List Devices

List Groups

List Managed Devices

List Patch Management Device

List Sessions

List Users

Raw Request

Scan Results Count

Update Account

Update Device

Update Group

Update Managed Device

Update Session

Update User

Changelog

2026-07-21

2026-04-30

2026-04-21

2026-04-10

2026-02-26

2025-08-15