TwitchApi.Users.GetUsers (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

This gets information about user 141981764.

requests:

curl -X GET 'https://api.twitch.tv/helix/users?id=141981764'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"id":"141981764","login":"twitchdev","display_name":"TwitchDev","type":"","broadcaster_type":"partner","description":"Supporting third-party developers building Twitch integrations from chatbots to game integrations.","profile_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png","offline_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png","view_count":5980557,"email":"not-real@email.com","created_at":"2016-12-14T20:32:28Z"}]}

Link to this section Summary

Types

User ID. Multiple user IDs can be specified. Limit: 100.

User login name. Multiple login names can be specified. Limit: 100.

Functions

Description:

Gets information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name.

Link to this section Types

Specs

id() :: %{id: String.t()}

User ID. Multiple user IDs can be specified. Limit: 100.

Specs

login() :: %{login: String.t()}

User login name. Multiple login names can be specified. Limit: 100.

Link to this section Functions

Specs

call(id() | login()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Gets information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name.

Required authentication:

OAuth or App Access Token required.

Required authorization:

OAuth token with user:read:email scope required to include the user’s verified email address in response.