Helix TeamHub API v2

Please note that this is an experimental version. Documentation for a stable one can be found here.

On these pages, you'll find everything you need to know about the Helix TeamHub REST APIs. These give you access to all data TeamHub stores and let you build any clients and integrations you need.

This page introduces the general concepts used throughout all TeamHub APIs, from authentication to the calling conventions and the error codes. To get information about specific types of data, use the navigation pane on the left.

• API version
• API stability
• Headers
• Authentication

API version

Starting with API v2, there is no need to include any additional headers describing the API version. Versioning is based on part of the URL, for example /api/v2/bots.

API stability

TeamHub APIs follow semantic versioning but only the major version number is used. Bug fixes and backward-compatible changes can be added to the same major version. Major TeamHub releases may deprecate an older version of APIs and introduce a new version. For example:

• Helix TeamHub 2.x supports v1.
• Helix TeamHub 3.x may introduce v2 and deprecate v1, or still continue supporting v1.

Headers

All requests require Accept and Content-Type headers to be set to application/vnd.api+json.

Authentication

All requests (except login/logout) require only account_key parameter to be present. It represents the user on whose behalf actions are taken.