twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

HelixTeamApi

The Helix API methods that deal with teams.

Overview

Can be accessed using client.helix.teams on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const tags = await api.helix.teams.getChannelTeams('125328655');

Methods

getTeamById(id)

async

Retrieves a team by ID.

Returns null if there is no team with the given ID.

Parameter Type Required Default Description
id string none

The ID of the team.

Return type: HelixTeamWithUsers | null

getTeamByName(name)

async

Retrieves a team by name.

Returns null if there is no team with the given name.

Parameter Type Required Default Description
name string none

The name of the team.

Return type: HelixTeamWithUsers | null

getTeamsForBroadcaster(broadcaster)

async

Retrieves a list of all teams a broadcaster is a member of.

Parameter Type Required Default Description
broadcaster UserIdResolvable none

The broadcaster to retrieve the teams of.

Return type: Array<HelixTeam>