TeamViewer

App · 20 actions

Manage remote devices, contacts, groups and support sessions; read users and connection reports.

Actions

ActionWhat it does
Create groupCreates a group.
Create support sessionPOST api/v1/Sessions.
Delete groupDeletes a group.
Delete support sessionDELETE api/v1/Sessions/{id}.
Get accountReturns the account.
Get connection reportGET api/v1/reports/connections/{id:Guid}.
Get contactRetrieves a specific contact by ID.
Get deviceGET api/v1/devices/{id}.
Get groupReturns group by groupId.
Get support sessionGET api/v1/Sessions/{id}.
Get userReturns a user.
List connection reportsList remote session reports, newest first, up to 1,000 at a time, with how many more remain and a link to the next page.
List contactsRetrieves all contacts with optional filtering.
List devicesGET api/v1/devices.
List groupsReturns groups by filter criteria.
List support sessionsGET api/v1/Sessions.
List usersReturns users with filter criteria.
Update devicePUT api/v1/Devices/{id}.
Update groupUpdates group.
Update support sessionPUT api/v1/Sessions/{id}.

Create group

Creates a group.

Inputs

NamenametextRequired
Name.
Policy IDpolicy_idtext
Policy ID.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "id": "example",
    "name": "example",
    "owner": {
      "alias": "example",
      "name": "example",
      "userid": "example"
    },
    "permissions": "example",
    "policy_id": "example",
    "shared_with": []
  }
}

Create support session

POST api/v1/Sessions.

Inputs

Valid untilvalid_untildate and time
Valid until.
Groupidgroupidtext
Groupid.
Custom IDcustom_idtext
Custom ID.
Groupnamegroupnametext
Groupname.
Support session typesupport_session_typenumber
Support session type.One of: 0, 1, 2, 3.
Sms invite numbersms_invite_numbertext
Sms invite number.
Sms invite languagesms_invite_languagenumber
Sms invite language.One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, and 23 more.
Waiting messagewaiting_messagetext
Waiting message.
Descriptiondescriptiontext
Description.
End customerend_customerobject
End customer.
Assigned useridassigned_useridtext
Assigned userid.
Custom apicustom_apitext
Custom api.
Tv versiontv_versiontext
Tv version.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "code": "example",
    "created_at": "example",
    "customId": "example",
    "custom_api": "example",
    "description": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_customer_link": "example",
    "groupid": "example",
    "state": 0,
    "support_session_type": 0,
    "supporter_link": "example",
    "tv_version": "example",
    "valid_until": "example",
    "waiting_message": "example",
    "webclient_supporter_link": "example"
  }
}

Delete group

Deletes a group.

Inputs

IdidtextRequired
GroupId of group

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {}
}

Delete support session

DELETE api/v1/Sessions/{id}.

Inputs

IdidtextRequired
id

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {}
}

Get account

Returns the account.

Inputs

None.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "available_licenses": [],
    "company_name": "example",
    "custom_field_has_paid_license": "example",
    "email": "example",
    "email_language": "example",
    "email_validated": false,
    "license": {
      "details": "example",
      "isactive": false,
      "license_type": 0,
      "teamViewerLicenseId": "example",
      "type": "example",
      "version": 1
    },
    "name": "example",
    "permissions": "example",
    "profilepicture_url": "example",
    "social_login_identity_issuer": "example",
    "userid": "example"
  }
}

Get connection report

GET api/v1/reports/connections/{id:Guid}.

Inputs

IdidtextRequired
id

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "billing_state": "example",
    "contact_id": "example",
    "currency": "example",
    "custom_api": "example",
    "deviceid": "example",
    "devicename": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_date": "example",
    "fee": 1.0,
    "feedback": {
      "session_rating": 1,
      "user_comment": "example"
    },
    "groupid": "example",
    "groupname": "example",
    "id": "example",
    "managedGroupIds": [],
    "managedGroupNames": [],
    "notes": "example",
    "session_code": "example",
    "session_created_at": "example",
    "session_note": "example",
    "start_date": "example",
    "support_session_type": 0,
    "userid": "example",
    "username": "example",
    "valid_until": "example"
  }
}

Get contact

Retrieves a specific contact by ID.

Inputs

IdidtextRequired
Contact ID (c-prefixed)

Outputs

dataobject
Response containing a list of contacts and optionally pending invitations.
Example output
{
  "data": {
    "contacts": [],
    "invitations": []
  }
}

Get device

GET api/v1/devices/{id}.

Inputs

IdidtextRequired
id

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "devices": []
  }
}

Get group

Returns group by groupId.

Inputs

IdidtextRequired
GroupId of group

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "id": "example",
    "name": "example",
    "owner": {
      "alias": "example",
      "name": "example",
      "userid": "example"
    },
    "permissions": "example",
    "policy_id": "example",
    "shared_with": []
  }
}

Get support session

GET api/v1/Sessions/{id}.

Inputs

IdidtextRequired
id

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "closed_at": "example",
    "code": "example",
    "created_at": "example",
    "custom_api": "example",
    "custom_module_id": "example",
    "description": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_customer_link": "example",
    "groupid": "example",
    "online": false,
    "state": "example",
    "support_session_type": "example",
    "supporter_link": "example",
    "tv_version": "example",
    "valid_until": "example",
    "waiting_message": "example",
    "webclient_supporter_link": "example"
  }
}

Get user

Returns a user.

Inputs

IdidtextRequired
User Identifier (UserId should start with u char)

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "activated_license_id": "example",
    "activated_license_name": "example",
    "activated_meeting_license_key": "example",
    "activated_subLicense_name": "example",
    "active": false,
    "creation_date": "example",
    "custom_quickjoin_id": "example",
    "custom_quicksupport_id": "example",
    "email": "example",
    "id": "example",
    "last_access_date": "example",
    "log_sessions": false,
    "name": "example",
    "online_state": "example",
    "password_updatedat": "example",
    "permissions": "example",
    "show_comment_window": false,
    "sso_status": 0,
    "tfa_enabled": false,
    "tfa_enforcement": false,
    "userRoleId": "example"
  }
}

List connection reports

List remote session reports, newest first, up to 1,000 at a time, with how many more remain and a link to the next page.

Inputs

Usernameusernametext
LocalSystemUser that created the session
Useriduseridtext
AccountId to which the session belongs
Groupidgroupidtext
GroupId that is used to filter session reports. Only reports to devices within this group will be returned. Special case: 0 means "no group", so only reports to unnamed devices are returned.
Managed group IDmanaged_group_idtext
Managed device group id that is used to filter session reports. Only reports to devices within this managed group will be returned.
Devicenamedevicenametext
ServerName. Used to filter reports. Only reports to devices with this name will be returned.
Deviceiddeviceidtext
TeamViewerId to filter sessions. Is a string as it is in the DB scheme.
From datefrom_datedate and time
Only reports of sessions that started on or after this date.
To dateto_datedate and time
Returned reports shall end before this date
Offset IDoffset_idtext
Used to partition the results. If there are more than 1000 results for a call, there is a link to the further results that contains the ParticipantSessionId of the last session. With this, we can exactly determine which results have already been received. All reports after the row with ParticipantSessionId will be returned when the results are ordered by end date descending. The row with the ID itself will be skipped.
Has codehas_codetrue/false
If set to true will filter out reports without a session code. If false, it will filter out reports with a session code. Will not filter out anything if the parameter is left out.
Session codesession_codetext
If specified only returns connection reports for specified session code
Support session typesupport_session_typetext
If specified only returns connection reports of the given session type - valid values are "RemoteConnection" / "1" and "RemoteSupportActive" / "2" and "RemoteSupportActiveSdk" / "3"
Session report featuressession_report_featureslist
If specified, only reports which have the specified feature will be returned.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "next_offset": "example",
    "records": [],
    "records_remaining": 1
  }
}

List contacts

Retrieves all contacts with optional filtering.

Inputs

Namenametext
Filter by name. Case-insensitive partial match (e.g., "John" matches "John Smith").
Online stateonline_statetext
Current online state.One of: online, busy, away, offline.
Emailemailtext
Filter by email address. Multiple addresses can be separated by comma or space.
Groupidgroupidtext
Filter by group ID (g-prefixed, e.g., 'g1000'). Returns only contacts in the specified group.
Include invitationsinclude_invitationstrue/false
When true, includes pending invitations (invited contacts who have not yet created their account) in the response. Default: false.

Outputs

dataobject
Response containing a list of contacts and optionally pending invitations.
Example output
{
  "data": {
    "contacts": [],
    "invitations": []
  }
}

List devices

GET api/v1/devices.

Inputs

Namenametext
parameters.name
Online stateonline_statetext
Current online state.One of: online, offline.
Groupidgroupidtext
parameters.groupid
Remotecontrol IDremotecontrol_idtext
parameters.remotecontrol_id

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "devices": []
  }
}

List groups

Returns groups by filter criteria.

Inputs

Namenametext
Name of the group
Sharedsharedtrue/false
Is group shared or not
Should match full nameshould_match_full_nametrue/false
Is name should match completely or not

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "groups": []
  }
}

List support sessions

GET api/v1/Sessions.

Inputs

Groupidgroupidtext
groupid
Assigned useridassigned_useridtext
assigned_userid
Statestatetext
Whether the support session is open or closed.One of: open, closed.
Full listfull_listtrue/false
full_list
Offsetoffsettext
offset

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "next_offset": "example",
    "sessions": [],
    "sessions_remaining": 1
  }
}

List users

Returns users with filter criteria.

Inputs

Emailemailtext
User email
Namenametext
User display name
Permissionspermissionstext
Comma separated access rights. Please use user role APIs for user's rights
Full listfull_listtrue/false
Is detailed user information needed

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {
    "users": []
  }
}

Update device

PUT api/v1/Devices/{id}.

Inputs

IdidtextRequired
id
Aliasaliastext
Alias.
Groupidgroupidtext
Groupid.
Descriptiondescriptiontext
Description.
Passwordpasswordtext
Password.
Policy IDpolicy_idtext
Policy ID.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {}
}

Update group

Updates group.

Inputs

IdidtextRequired
GroupId of group
Namenametext
Name.
Policy IDpolicy_idtext
Policy ID.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {}
}

Update support session

PUT api/v1/Sessions/{id}.

Inputs

IdidtextRequired
id
Groupidgroupidtext
Groupid.
Custom module IDcustom_module_idtext
Custom module ID.
Groupnamegroupnametext
Groupname.
Waiting messagewaiting_messagetext
Waiting message.
Descriptiondescriptiontext
Description.
End customerend_customerobject
End customer.
Assigned useridassigned_useridtext
Assigned userid.
Custom apicustom_apitext
Custom api.
Statestatetext
Whether the support session is open or closed.One of: open, closed.
Tv versiontv_versiontext
Tv version.
Sms invite numbersms_invite_numbertext
Sms invite number.
Sms invite languagesms_invite_languagenumber
Sms invite language.One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, and 23 more.

Outputs

dataobject
Team Viewer response data.
Example output
{
  "data": {}
}

On this page