Request User Groups via API

kpx

When i request user groups i get licence required. I've got a corporate licence and permissions set on the key. Why is this and how do i fix it?

I'm aiming to get the id of a user group so i can share a device group with that user group via api.

curl -X 'GET' \ 'https://webapi.teamviewer.com/api/v1/usergroups' \ -H 'accept: application/json' \ -H 'Authorization: Bearer MYKEYGOESHERE'

{ "error": "license_required", "error_description": "A license is required to perform this action", "error_code": 11}

SophE

Hi @kpx,

Welcome to the TeamViewer Community, and thanks for sharing the details.

The error message { "error": "license_required", "error_description": "A license is required to perform this action", "error_code": 11} indicates that the API token you are using does not belong to an account with an active license, even if you own a Corporate license.

This usually happens when the account that provided the API token does not have a license.

How to fix it

1. Sign in with the TeamViewer account that holds your Corporate license.
2. Re‑create the API token from this licensed account.
3. Use this new token for all API requests, including: GET https://webapi.teamviewer.com/api/v1/usergroups

In the following, you can find some helpful references:

How to use the TeamViewer API

https://webapi.teamviewer.com/api/v1/docs/index

TeamViewer API documentation (PDF)

Once your token is generated for the correct account, you should be able to retrieve user group IDs and share device groups via the API.

If you have any further questions, we're happy to support you further here in the Community.

Best,
Sophia