OBJECT

User

Twitch user.

link GraphQL Schema definition

1type User {
2
3# Information about a user's connected accounts.
4accountConnections: AccountConnectionSet!
5
6# Information about a user's account health status.
7accountHealth: UserAccountHealth
8
9# Fetch active challenges for the user based on a variety of sorting options.
10# By default returns 10 challenges, sorted by start time.
11activeChallenges(
12first: Int,
13after: Cursor,
14sort: ChannelChallengeSort,
15direction: SortOrder
16): ChannelChallengeConnection
17
18# An action that a user or session is performing. This field is null if the user
19# is not friends with
20# the authenticated user.
21activity: Activity
22
23# Ad Properties for the given user.
24adProperties: AdProperties
25
26# The user's relationship with Amazon.
27amazon: UserAmazonConnection @deprecated( reason: "Retail sales discontinued" )
28
29# List of authenticated Twitch sessions.
30authenticatedSessionList: [AuthenticatedSession!]
31
32# AutoModProperties is a mapping of automod categories to levels, i.e. a user has
33# indicated they want level 4, or
34# the highest level of moderation for profanity, but level 1 for everything else.
35# (These are based on Sift levels, and will be deprecated).
36autoModProperties: AutoModProperties
37
38# A user's configured auto refill information, contains all auto refill profiles.
39# Will have an optional filter argument in the future.
40autoRefill: AutoRefill
41
42# The list of channels that this user has configured to automatically host
43# when their channel is not streaming live. Users can only view their own
44# autohost channels.
45autohostChannels: AutohostChannelConnection
46
47# Options and preferences for autohost behavior, including whether
48# autohosting is enabled at all and how to choose which channel to host.
49# Users can only view their own autohost settings.
50autohostSettings: AutohostSettings
51
52# The list of channels that have added this user as a channel to automatically
53# host when their channel is not
54# streaming live. Users can only view their own autohosted by channels.
55autohostedByChannels: AutohostedByChannelConnection
56
57# An action that a user or session is performing. This field is null if the user
58# is not friends with
59# the authenticated user.
60availability: Availability
61
62# The badges which are available for the authenticated user to select for use on
63# another user's streams and videos if no channel-specific preference is set.
64# If no domain is not specified, all emote sets will be returned.
65# This is only returned if the request is authenticated by the same user whose
66# email is requested.
67availableBadges(domains: [BadgeDomain!]): [Badge]
68
69# A list of this user's balances in FIAT currencies
70# If this isn't the `currentUser` this will return null.
71balances(
72walletType: WalletType
73): [Balance] @deprecated( reason: "Use walletBalances" )
74
75# A list of this user's banned users.
76# A maximum of 100 users by most recent are returned
77# Only resolves for the authenticated user.
78bannedUsers: [ChannelBannedUser!]
79
80# A URL to the user's banner image.
81bannerImageURL: String
82
83# bitsBalance is the number of bits this user currently has available to spend.
84# If this isn't the `currentUser` or the user has been banned from using bits this
85# will return null.
86# This field can only be requested if an OAuth token is supplied with the request.
87bitsBalance: Int
88
89# bitsEvents returns a paginated list of this user's bits usage transactions
90# If this isn't the `currentUser` this will return null.
91# This field can only be requested if an OAuth token is supplied with the request.
92bitsEvents(
93first: Int,
94after: Cursor,
95criteria: BitsEventConnectionCriteriaInput!
96): BitsEventConnection
97
98# bitsOffers is a list of the ways this user can obtain more bits.
99# If this isn't the `currentUser` or the user has been banned from using bits this
100# will return null.
101# This field can only be requested if an OAuth token is supplied with the request.
102bitsOffers: [BitsOffer]
103
104# BitsPaymentMethods has a list of eligible payment methods for a user to transact
105# with.
106bitsPaymentMethods: BitsPaymentMethods
107
108# BitsProductEligibility checks for a given user if they are eligible to purchase
109# a given product from the associated
110# provider, quantity, and locale.
111# bitsProduct(id: ID!, provider: BitsProductProvider!, quantity: Int!, locale:
112# String!): BitsProductEligibility!
113# bitsProducts is a list of bits products that a user is able to purchase.
114# Unlike bitsOffers, this does not return any pricing information, only
115# information
116# about the purchasable. A provider must be supplied, which is the payment
117# platform
118# being currently used. An optional list of SKUs can be provided if we are looking
119# up
120# a specific set of products for a user.
121bitsProducts(
122provider: BitsProductProvider!,
123skus: [String!],
124paymentProvider: PaymentProvider
125): [BitsProduct!]
126
127# Settings tied to a bits user.
128bitsUserSettings: BitsUserSettings
129
130# bitsUserState dictates the state of the Bits user (new to Bits, existing Bits
131# user, etc.)
132# If this isn't the `currentUser` or the user has been banned from using bits this
133# will return null.
134# This field can only be requested if an OAuth token is supplied with the request.
135bitsUserState: BitsUserState
136
137# Resolves account information that Twitch has stored for a user's blizzard
138# account information.
139blizzardAccount: BlizzardUser
140
141# Get the blocked terms of a user.
142blockedTerms: [ChannelBlockedTerm!]!
143
144# blockedUsers returns a list users that are restrained from directly
145# communicating with this user.
146blockedUsers: [User]!
147
148# bounties is a list of bounty board bounties for this user.
149bounties(
150status: String!
151): [Bounty!] @deprecated( reason: "Use user.bountiesPage instead" )
152
153# bountiesPage is a paginated list of bounty board bounties for this user.
154bountiesPage(first: Int, after: Cursor, status: String!): BountyConnection
155
156# bountyBoardSettings are settings and rules around the behavior of bounty boards
157# for this user.
158bountyBoardSettings: BountyBoardSettings
159
160# Badges that are displayed in chat during this user's broacasts or videos.
161broadcastBadges: [Badge]
162
163# A User's broadcast settings that persists between streams.
164broadcastSettings: BroadcastSettings
165
166# A User's campaign for their channel.
167campaign(
168campaignID: ID!
169): Campaign @deprecated( reason: "campaign events have been deprecated" )
170
171# A User's campaign properties for their channel.
172campaignProperties: CampaignProperties @deprecated( reason: "campaign events have been deprecated" )
173
174# A container for celebration settings for the logged in user.
175celebrationSettings: CelebrationUserSettings
176
177# The channel which belongs to the user. This is still deprecated for previous
178# uses.
179# This should only be used for the multi-view experience.
180channel: Channel
181
182# What other similar content are my viewers watching.
183channelAnalyticsContentOverlap: ChannelAnalyticsContentOverlap
184
185# A user's channel feed.
186# No authorization required. Returns even if channel feed is disabled in the UI.
187channelFeed: Feed
188
189# Returns the list of chatrooms in the channel visible by the current user.
190channelRooms: [Room]! @deprecated( reason: "The Rooms product has been sunset" )
191
192# Hex color of the user's name in chat, e.g. "#ccaa44".
193chatColor: String
194
195# chatSettings are settings and rules for chatting in this user's channel.
196chatSettings: ChatSettings
197
198# chatUISettings are settings for the user's chat UI.
199chatUISettings: ChatUISettings
200
201# cheer is the channel-specific cheer settings and current state.
202# Returns null if cheering isn't enabled for this channel.
203cheer: CheerInfo
204
205# The list of OAuth clients authorized by the current user.
206clientAuthorizations: [ClientAuthorization!]
207
208# A paginated list of clips featuring this user.
209# When criteria is not specified, the default values are used.
210clips(first: Int, after: Cursor, criteria: UserClipsInput): ClipConnection
211
212# A paginated list of collections (playlists) created by the user.
213collections(first: Int, after: Cursor, options: CollectionsOptions): CollectionsConnection
214
215# Properties relating to the authenticated user's community points on twitch.
216communityPoints: CommunityPointsUserProperties
217
218# The company that the user belongs to.
219# Returns null if the user doesn't belong to a company.
220company: Company @deprecated( reason: "Use organizations instead." )
221
222# The competitions that a user is involved in.
223# Returns null if the user doesn't have any competitions.
224# user and competition state can be null.
225competitions(
226first: Int,
227after: Cursor,
228userState: CompetitionPlayerState,
229competitionState: CompetitionState,
230userCompetitionRelationship: UserCompetitionRelationship!
231): CompetitionConnection
232
233# When the user created their account.
234createdAt: Time!
235
236# The container for creator gifts the creator has. This will be null if the
237# creator
238# does not have this feature enabled.
239creatorGifting: CreatorGifting
240
241# Creator metrics for the given time period.
242creatorMetricsByInterval(
243startAt: Time!,
244endAt: Time!,
245timeZone: String,
246numberOfIntervals: Int
247): CreatorMetricsByInterval
248
249# Get the user's referral links sorted by most recently created first. Will be a
250# null CreatorReferralLinkConnection if the user is not eligible.
251creatorReferralLinks(first: Int, after: Cursor): CreatorReferralLinkConnection
252
253# Get the user's creator referral link statistics summary.
254creatorReferralSummary(startAt: Time!, endAt: Time!): CreatorReferralSummary!
255
256# Paginated past activities for the Dashboard Activity Feed.
257# Always ordered by descending timestamp.
258dashboardActivityFeedActivities(
259first: Int,
260after: Cursor
261): DashboardActivityFeedActivityConnection
262
263# Paginated past activities for the Dashboard Alert Queue.
264# Always ordered by descending timestamp.
265dashboardAlertQueueActivities(
266first: Int,
267after: Cursor
268): DashboardAlertQueueActivityConnection
269
270# Preferences that control what alerts are sent to the user for the Dashboard
271# Alert Queue.
272dashboardAlertQueuePreferences: DashboardAlertQueuePreferences
273
274# Timestamp when a user's account was deleted/disabled.
275deletedAt: Time
276
277# A user-provided blurb describing themselves.
278# Returns null when a description has not been set.
279description: String
280
281# The directories the user is currently set to broadcast in.
282directories: UserDirectoryConnection
283
284# Lists the chat badges that should be displayed by the user's display name in
285# features like chat and whispers. If a channelID is passed in, fetches the
286# display badges that user will have in that channel's context.
287# Includes the following badges:
288# - global authority (staff/admin/global mod)
289# - channel authority (broadcaster/mod, if channelID is set)
290# - subscriber (if channelID is set)
291# - channel selected (bits) or global selected (prime, turbo, ...).
292displayBadges(channelID: ID, channelLogin: String): [Badge]!
293
294# A user-styled version of their login.
295# For international users, this could be the user's login with localized
296# characters.
297displayName: String!
298
299# Number of DMCA violations user has received.
300dmcaViolationCount: Int
301
302# A drop 2.0 campaign including personal settings (e.g. account connection
303# status). (Viewer dashboard individual item).
304dropCampaign(id: ID!): DropCampaign
305
306# A list of all available Drops 2.0 Campaigns that a user is eligible to
307# participate in. (Viewer dashboard list).
308dropCampaigns: [DropCampaign!]
309
310# Fetch User's current session, which describes the minutes-watched progress
311# towards a drop.
312dropCurrentSession: DropCurrentSession
313
314# A list of channels where the user is an editor.
315editableChannels: EditableChannelConnection
316
317# A list of channel editors.
318editors: EditorConnection
319
320# The user's email address.
321# This is only returned if the request is authenticated by the same user who's
322# email is requested.
323email: String
324
325# The emote sets this user is entitled to use.
326# If no domains are specified, all emote sets will be returned.
327# If multiple domains are specified, emotes that belong to either domain are
328# returned (OR).
329# If this user is not the current user, it returns nil and a "forbidden" error.
330emoteSets(domains: [EmoteSetDomain!]): [EmoteSet!]
331
332# The channel's emoticon prefix settings.
333emoticonPrefix: EmoticonPrefix
334
335# The list channels that have been endorsed by the user.
336endorsedChannels(
337first: Int,
338recommendationsContext: RecommendationsContext!
339): EndorsedChannelConnection
340
341# A paginated list of user's all expired subscriptions.
342# Only resolves for the current user. Returns a forbidden error if requested for
343# another user.
344expiredSubscriptions(first: Int, after: Cursor): ExpiredSubscriptionConnection
345
346# Feature flags specific to this user.
347# Always returns nil.
348featureFlags: FeatureFlags @deprecated( reason: "this functionality has been removed" )
349
350# A follow relationship between this user and the one which has the target ID or
351# login.
352# Null if no relationship exists.
353follow(
354targetID: ID,
355targetLogin: String
356): Follow @deprecated( reason: "Use user.self.follower instead." )
357
358# Retrieves a list of games which the user is following.
359followedGames(first: Int, type: FollowedGamesType): FollowedGameConnection
360
361# A list of broadcasters this user follows, who are hosting other broadcasters.
362# Only resolves for the authenticated user.
363followedHosts(
364first: Int
365): FollowedHostConnection @deprecated( reason: "This field is intended to be replaced as soon as an alternative is available." )
366
367# A list of live-streaming broadcasters this user is following.
368# Only resolves for the authenticated user.
369# NOTE: the sort input parameter is not supported and should not be used.
370followedLiveUsers(
371first: Int,
372after: Cursor,
373includeRestricted: [StreamRestrictionType!],
374sort: StreamSort
375): FollowedLiveUserConnection @deprecated( reason: "This field is intended to be replaced as soon as an alternative is available." )
376
377# Retrieves recent/popular VODs from the streamers you follow.
378# If this isn't the `currentUser` this will return null.
379followedVideos(
380first: Int,
381after: Cursor,
382languages: [String!],
383types: [BroadcastType!],
384sort: VideoSort
385): VideoConnection
386
387# A paginated list of users which follow this user.
388followers(first: Int, after: Cursor, order: SortOrder): FollowerConnection
389
390# A paginated list of users this user is following.
391follows(first: Int, after: Cursor, filter: FollowsFilter, order: SortOrder): FollowConnection
392
393# A list of this user's Twitch friends.
394# A maximum of 500 friends are returned, although most users have less than the
395# maximum.
396# Only accessible if the user is authenticated with the
397# `user_presence_friends_read` scope.
398friends: FriendConnection
399
400# Notification connection information for a time range.
401goLiveNotificationConnection(
402startAt: Time!,
403endAt: Time!,
404first: Int,
405after: Cursor,
406sort: SortOrder
407): GoLiveNotificationConnection
408
409# Notification information for a time range.
410goLiveNotifications(
411startAt: Time!,
412endAt: Time!,
413first: Int,
414sort: SortOrder
415): [GoLiveNotification!]
416
417# Notifications timeseries analytics for a time range.
418goLiveNotificationsTimeseries(
419startAt: Time!,
420endAt: Time!,
421granularity: Granularity!,
422numberOfIntervals: Int,
423timeZone: String!
424): [GoLiveNotificationTimeseries!]
425
426# Always returns false, will be deleted soon.
427hasBadgesTimedOut: Boolean! @deprecated( reason: "this functionality has been removed" )
428
429# Whether this user has Twitch Presto.
430hasPresto: Boolean
431
432# Whether this user has Twitch Prime.
433hasPrime: Boolean!
434
435# Whether this user has streamed before.
436hasStreamed: Boolean
437
438# Whether this user has Twitch Turbo.
439hasTurbo: Boolean!
440
441# Whether this user has unread creator changelog items.
442hasUnreadChangelogItems: Boolean
443
444# This user's Hero configuration.
445hero: Hero
446
447# A curated list of suggested channels to host.
448hostRecommendations: [User]
449
450# The users hosting this user.
451# This field only resolves for the authenticated user, otherwise resolves to null.
452hostedBy(first: Int, after: Cursor): HostConnection
453
454# The user who this user is hosting.
455hosting: User
456
457# The user's unique identifier.
458id: ID!
459
460# Returns a SHA-1 hash of the id field.
461idSHA1: ID!
462
463# A list of open friend requests sent to this user. Friend requests from
464# non-strangers are always placed in front of
465# friend requests from strangers; `sort` affects how the two components are
466# ordered within themselves. Only accessible
467# if the user is authenticated with the `user_presence_friends_read` scope.
468incomingFriendRequests(
469first: Int,
470after: Cursor,
471sort: FriendSort
472): IncomingFriendRequestConnection
473
474# A list of the squad stream invitations that the user has received.
475# Each invitation has a network type of either in-network or out-of-network. The
476# invitations are sorted by creation
477# time, with the latest invitation first.
478# This field only resolves for the authenticated user.
479incomingSquadStreamInvitations: SquadStreamInvitationConnection
480
481# The list of extensions the user has installed.
482# installedExtensions gives a set of Extension installations, but does not include
483# some of the information required
484# to render extensions. For this, use extensionsForChannel instead, where you
485# will get more accurate response, and
486# which includes fetched extension configuration and extension permissions.
487installedExtensions: [ExtensionInstallation!]
488
489# Items (crates, drops, etc.) the user owns.
490inventory: Inventory
491
492# A list of teams that the user has been invited to.
493# Only resolves for the current user.
494invitedTeams: [Team]
495
496# Whether or not the broadcaster is eligible for payout through twitch game
497# commerce revenue share.
498isCommerceRevShareEnabled: Boolean! @deprecated( reason: "Game sales discontinued" )
499
500# Whether the user's Twitch account is connected to a Twitter account.
501# Returns nil if there was an error. This field is only accessible on the current
502# user.
503isConnectedToTwitter: Boolean
504
505# Whether or not the user has enabled their email to be reused to create another
506# twitch account.
507isEmailReusable: Boolean!
508
509# Whether or not the user can update their email.
510isEmailUpdateable: Boolean!
511
512# Whether or not the user has verified their email address by clicking a link sent
513# to their email.
514isEmailVerified: Boolean!
515
516# Indicates that the owner of the email on the account did not signup for this
517# account
518# This mainly implies that the account is being deleted and not eligible for self
519# service reactivation.
520isFlaggedToDelete: Boolean!
521
522# Whether or not the user can moderate any broadcast chat.
523isGlobalMod: Boolean! @deprecated( reason: "Use user.roles.isGlobalMod instead." )
524
525# Whether or not the user is in good standing, granting automatic emote approval.
526# Passes both the authed twitch user who is requesting and the user they are
527# requesting.
528# Applies to both affiliates and partners.
529isInEmoteGoodStanding: Boolean
530
531# Whether or not the user is in good standing generally.
532# Authenticated to current user. Will error if not a partner.
533isInGoodStanding: Boolean!
534
535# Whether the user meets the GDPR compliance as per his/her country's minimum
536# compliance age.
537isMinimumGDPRConsentAge: Boolean!
538
539# Whether or not the user is moderator of a another user's channel.
540isModerator(channelID: String!): Boolean!
541
542# Whether or not the user is a partnered broadcaster with Twitch.
543isPartner: Boolean @deprecated( reason: "Use user.roles.isPartner instead." )
544
545# Whether or not the user has verified their phone number.
546# This is currently always true if the user has a phone number.
547# We do not not allow a user to set a phone number without verifying.
548isPhoneNumberVerified: Boolean!
549
550# Whether or not the user is a site admininistrator.
551isSiteAdmin: Boolean! @deprecated( reason: "Use user.roles.isSiteAdmin instead." )
552
553# Whether or not the user is a Twitch staff member.
554isStaff: Boolean! @deprecated( reason: "Use user.roles.isStaff instead." )
555
556# The key pools associated with a user.
557keyPools(after: String): KeyPoolConnection
558
559# The user's language preference.
560language: Language @deprecated( reason: "Use user.settings.preferredLanguageTag instead." )
561
562# The user's last broadcast.
563lastBroadcast: Broadcast
564
565# When the user last updated their login name.
566# This special field only resolves for the authenticated user.
567lastLoginChangeAt: Time
568
569# The last time the user's availability or activity changed.
570# This special field only resolves for the authenticated user; use
571# friends.edges.lastStatusChangeAt to retrieve this
572# information about friends..
573# Requires the `user_presence_friends_read` scope.
574lastStatusChangeAt: Time
575
576# Fetches the latest created Poll for the user.
577latestPoll: Poll
578
579# The extensions this user has shared their identity with.
580linkedExtensions: [Extension!]
581
582# The user's standard alphanumeric Twitch name.
583login: String!
584
585# The user's profile image.
586# Valid widths are 28, 50, 70, 150, 300, and 600.
587# The image height will be the same as the given width.
588logoURL(
589width: Int!
590): String @deprecated( reason: "Replaced by profileImageURL" )
591
592# Lists a User's Uploaded Loyalty Badge.
593loyaltyBadges: [LoyaltyBadge!]
594
595# Returns the max number of channel rooms that the current user is allowed to
596# create for their channel.
597maxAllowedChannelRooms: Int! @deprecated( reason: "The Rooms product has been sunset" )
598
599# Returns a resolver to query different subsets of the moderation logs.
600modLogs: ModLogs
601
602# Returns all channel roles' access permissions to moderator logs.
603modLogsAccess: [ModLogsAccess!]
604
605# Returns a channel role's access permission to moderator logs.
606modLogsRoleAccess(role: ChannelUserRole!): ModLogsAccess
607
608# A user's settings related to the moderation view page.
609modViewSettings: ModViewSettings
610
611# Returns a paginated list of channel moderators.
612mods(first: Int, after: Cursor): ModConnection
613
614# A user's event notification settings.
615notificationSettings: [EventNotificationSetting!]
616
617# A user's notifications.
618# This is only returned if the request is authenticated by the same user whose
619# onsite notifications are requested.
620# `language` is a letter code for the language the requesting user speaks (ex.
621# "en").
622notifications(
623first: Int,
624after: Cursor,
625language: String,
626displayType: OnsiteNotificationDisplayType,
627capabilities: [OnsiteNotificationsCapability!]
628): OnsiteNotificationConnection
629
630# OAuth applications developed by the current user.
631oauthApps(after: Cursor): OAuthAppConnection
632
633# A URL to the image that is displayed when the user is not broadcasting nor
634# hosting another user's broadcast.
635offlineImageURL: String
636
637# Information about the current user's onboarding state.
638onboarding: Onboarding @deprecated( reason: "This feature has been sunset." )
639
640# List of invites to join an organization.
641organizationInvites(first: Int, after: Cursor): OrganizationInviteUserConnection
642
643# Returns a list of developer organizations.
644# Returns null if the user doesn't belong to any organizations.
645organizations: [Organization!]
646
647# A list of open friend requests sent by this user. Friend requests to
648# non-strangers are always placed in front of
649# friend requests to strangers; `sort` affects how the two components are ordered
650# within themselves. Only accessible
651# if the user is authenticated with the `user_presence_friends_read` scope.
652outgoingFriendRequests(
653first: Int,
654after: Cursor,
655sort: FriendSort
656): OutgoingFriendRequestConnection
657
658# A list of teams owned by the user.
659# Only resolves for the current user.
660ownedTeams: [Team]
661
662# panels is a list of `Panel` objects with information related to this channel.
663panels(hideExtensions: Boolean): [Panel]!
664
665# Fetch participating challenges for the user based on a variety of sorting
666# options.
667# By default returns 10 challenges, sorted by end time.
668participatingChallenges(
669first: Int,
670after: Cursor,
671sort: ChannelChallengeSort,
672direction: SortOrder,
673status: [ChannelChallengeStatus!]
674): ChannelChallengeConnection
675
676# Non-partnered users can submit a partnership application via
677# createPartnershipApplication mutation.
678# PartnershipApplication includes the status of the most recently submitted
679# application.
680partnershipApplication: PartnershipApplication
681
682# Whether or not the user is able to be paid.
683payableStatus: PayableStatus
684
685# Metrics that are relevant to incentive-based contracts for some partnered
686# streamers. This API returns a year-to-date, rolling list of the past 12
687# months and includes the current (in-progress) month.
688paymentIncentiveMetrics: [PaymentIncentiveMetricsRollup!]
689
690# Holds configuration necessary to start payment method management. Only the
691# authenticated user can access their own configs.
692# This is the second step of the payment method management flow.
693# (User.paymentMethods -> User.paymentMethodConfigs ->
694# Mutation.setDefaultPaymentMethod).
695paymentMethodConfigs: PaymentProviderConfigs
696
697# List of payment methods that will be used to pay for Twitch subscriptions that
698# renew in the future
699# This is the first step of the payment method management flow.
700# (User.paymentMethods -> User.paymentMethodConfigs ->
701# Mutation.setDefaultPaymentMethod).
702paymentMethods: [PaymentMethod!]
703
704# Get user's list of payment transactions. This currently aggregates subscriptions
705# related transactions but plans
706# to also aggregate other product types such as Bits. The ultimate goal is to
707# record, aggregate, and provide the
708# payment history of Twitch users in a convenient way.
709paymentTransactions(
710first: Int,
711after: Cursor,
712criteria: PaymentTransactionConnectionCriteriaInput!
713): PaymentTransactionConnection
714
715# Payout Information.
716payout: Payout
717
718# Accrued balance since last payout.
719payoutBalance: PayoutBalance
720
721# A user's invite into a payout program.
722payoutInvite: PayoutInvite
723
724# List of payout plans a user has when enrolled in any payout programs.
725payoutPlans: [PayoutPlan!]
726
727# Get the permitted terms of a user.
728permittedTerms: [ChannelPermittedTerm!]!
729
730# The user's phone number. Format is always in E.164 format.
731# This is only returned if the request is authenticated by the same user whose
732# phone is requested.
733phoneNumber: String
734
735# Fetch polls for the user based on a variety of sorting options.
736# By default returns 15 polls, sorted by start time.
737polls(
738first: Int,
739after: Cursor,
740sort: PollSort,
741direction: SortOrder,
742status: [PollStatus!]
743): PollConnection
744
745# Options and preferences for how the user participates in Predictions Events.
746# Users can only view their own Predictions Settings.
747predictionsSettings: UserPredictionSettings
748
749# The amount of preroll free time in seconds that a user has earned on their
750# channel.
751prerollFreeTimeSeconds: Int
752
753# The hex string for the user's primary creator color.
754# Example: "FFFFFF".
755primaryColorHex: String
756
757# The primary team this user belongs to. A user may belong to more than one team
758# at the same time but must select a single
759# team as the primary. If the user doesn't have a primary team this will be null.
760primaryTeam: Team
761
762# Always returns null, will be removed soon.
763primePayoutDetails: PrimePayoutDetails @deprecated( reason: "Use primePayoutHistory, this will be removed soon" )
764
765# The prime payout details over a period of time for the user.
766primePayoutHistory: [PrimePayoutDetail!]
767
768# The Twitch Prime settings data for the user.
769primeSettings: PrimeSettings
770
771# A URL to the user's profile image.
772# Valid widths are 28, 50, 70, 96, 150, 300, and 600.
773# The image height will be the same as the given width.
774profileImageURL(width: Int!): String
775
776# The URL to viewing this user's profile.
777# This is typically https://twitch.tv/ .
778profileURL: String!
779
780# The number of views this user's profile has received since creation.
781profileViewCount: Int
782
783# The program agreement for a user enrolled in a payout program.
784programAgreement: ProgramAgreement
785
786# A user's pulse feed.
787# This is only returned if the request is authenticated by the same user whose
788# email is requested.
789pulseFeed: Feed
790
791# PurchaseOrder returns a user's purchase order.
792purchaseOrder(id: ID!): PurchaseOrder
793
794# Quests associated with a user.
795quests: Quests
796
797# Twitch Radio for the user.
798radio: Radio
799
800# Twitch Radio account information.
801radioAccount: RadioAccount @deprecated( reason: "Use user.radio.account instead." )
802
803# Always returns null.
804raid: Raid @deprecated( reason: "this feature has been moved" )
805
806# Preferences for raid behavior, including whether
807# raids are enabled and from whom can raids orignate.
808# Users can only view their own raid settings.
809raidSettings: RaidSettings
810
811# An array of recent raids by the broadcaster.
812recentRaids: [Raid!]
813
814# The feedback a user has given about recommended content.
815recommendationFeedback(
816limit: Int,
817after: Cursor,
818type: String!
819): RecommendationFeedbackConnection
820
821# Recommendations for the user. Recommendations can be retrieved only if the
822# request
823# is authenticated and only for the authenticated user.
824recommendations: Recommendations
825
826# The recommended prefix which is generated based on user name.
827recommendedEmoticonPrefix: String!
828
829# This user's relationship with another user.
830relationship(targetUserID: ID): UserRelationship
831
832# User's declared country of residence.
833residence: UserResidence
834
835# Info on rewarded video for a user (eligibility).
836rewardedVideo: RewardedVideo
837
838# The roles this user fulfills on Twitch.
839roles: UserRoles
840
841# Search through a paginated list of public and private videos for this user.
842searchVideos(
843first: Int,
844after: Cursor,
845search: VideoConnectionSearchParams
846): VideoConnection
847
848# A list of streamer onboarding content IDs that that the user has been shown, and
849# when it was first shown.
850seenCreatorOnboardingContent: [CreatorOnboardingContent!]
851
852# The badge this user has selected for global use on Twitch.
853selectedBadge: Badge
854
855# The authenticated user's relationship with this user.
856self: UserSelfConnection
857
858# Loads the extension installation data for the queried userID's channel that is
859# relevant to the calling user.
860# This includes the extension configuration data & auth tokens for the
861# extension-channel-user combination.
862selfInstalledExtensions(isMobile: Boolean): [ExtensionInstallationSelfEdge!]
863
864# The settings this user has on Twitch.
865settings: UserSettings
866
867# The squad stream that this user is currently a member of, or null if the user is
868# not a member of
869# any squad stream.
870squadStream: SquadStream
871
872# squadStreamSettings are the user's rules and settings for the squad stream
873# feature.
874# Some fields only resolve for the authenticated user. See schema definition for
875# more detail.
876squadStreamSettings: SquadStreamSettings
877
878# The relationship between the authenticated user and the single sign-on (SSO)
879# apps they have linked to their Twitch account.
880ssoLinks(
881app: String
882): [SSOLink!] @deprecated( reason: "Service has been shut down" )
883
884# The user's live stream.
885# Null if the user is not currently broadcasting.
886stream: Stream
887
888# A list of the start and end times of stream sessions.
889streamSessions(first: Int, lastStartedAt: Time): [StreamSession!]
890
891# A list stream sessions that started and ended during the specified interval.
892streamSessionsByInterval(startAt: Time!, endAt: Time!): [StreamSession!]
893
894# A list of stream summaries. Stream summaries provide analytics information
895# for a streaming session. Last started time is for querying sessions from a
896# previous time stamp.
897streamSummaries(first: Int, lastStartedAt: Time): [StreamSummary!]
898
899# Stucco packs displayed in the user's dashboard stucco settings.
900stuccoPacksBroadcaster: [StuccoPack]
901
902# stuccos available in the library in the user's dashboard stucco settings.
903stuccos: [Stucco]
904
905# A list of channels to which the user is subscribed.
906# Only resolves for the authenticated user.
907subscribedChannels(first: Int, after: Cursor, live: Boolean): SubscribedChannelConnection
908
909# The subscription score of the user. Returns both a breakdown of subscriptions
910# and points by tier.
911# Authenticated to the current user. Will be nil if the user is not a partner or
912# affiliate.
913subscriberScore: SubscriberScore
914
915# A paginated list of user's all active subscriptions.
916# Only resolves for the current user. Returns a forbidden error if requested for
917# another user.
918subscriptionBenefits(
919first: Int,
920after: Cursor,
921criteria: SubscriptionBenefitCriteriaInput!
922): SubscriptionBenefitConnection
923
924# A list of subscription products available for purchase on the user's page.
925subscriptionProducts: [SubscriptionProduct]
926
927# A list of subscription products available for purchase on the user's page,
928# including handleable errors.
929subscriptionProductsResult: SubscriptionProductsResult!
930
931# Subscription preferences for the current user.
932# Only resolves for the current user. Returns an error if request for another
933# user.
934subscriptionSettings: UserSubscriptionSettings
935
936# Subtoken information associated with the user.
937# Includes balance of tokens which can be used to redeem Subscriptions.
938subscriptionToken: SubscriptionToken
939
940# Analytics of the frequency of tags used in discovery.
941tagAnalytics: [TagAnalytic!]
942
943# Tags are used as a discovery and search mechanism for channels.
944# The tag data is from Graffiti directly. Graffiti is not designed to handle huge
945# traffic.
946# Please use Stream.tags instead if know the stream is live and you can accept a 5
947# min delay in the data.
948# For example, you should use Stream.tags for the channel page and the browse
949# page, but use User.tags for the dashboard.
950tags: [Tag!]
951
952# A list of UserTeamMemberships which includes all the teams the user is a member
953# of.
954# This includes the primary team.
955# Only resolves for the current user.
956teamMemberships: [UserTeamMembership]
957
958# Retrieves all the statistics within the start and end time broken down by
959# granularity.
960# Default endAt time will be the current time (now).
961# Granularity defaults to 5 minutes.
962timeseriesStats(
963startAt: Time!,
964endAt: Time,
965timeZone: String!,
966granularity: Granularity
967): TimeseriesStats
968
969# Tournament associated with the user. This is used with the Bits custom cheering
970# experience.
971tournament: Tournament @deprecated( reason: "No longer supported" )
972
973# The user's relationship with Twitch.
974twitch: UserTwitchConnection
975
976# Get unacknowledged subscription events.
977unacknowledgedSubscriptionEvents(
978platform: String!
979): [UnacknowledgedSubscriptionEvent!]
980
981# When the user last updated their account.
982# Returns null when the user's account has never been updated.
983updatedAt: Time
984
985# Verification request object for the user and an associated contact address.
986# If no address is provided, the current email address associated with the user
987# account will be used.
988verificationRequest(address: String): VerificationRequest
989
990# Aggregated analytics for several video referral sources, for use in channel
991# analytics.
992videoPlayReferrals(
993start: Time!,
994end: Time!,
995filter: ReferralsFilter,
996dimension: ReferralsDimension!,
997first: Int
998): VideoPlayReferrals
999
1000# A paginated list of video shelves to display on the user's channel.
1001videoShelves(first: Int, after: Cursor, options: ShelvesOptions): VideoShelfConnection
1002
1003# A paginated list of video shelves that are available to be displayed on the
1004# user's channel. Only accessible for authorized users (user & editors).
1005videoShelvesAvailable(
1006first: Int,
1007after: Cursor,
1008options: ShelvesAvailableOptions
1009): VideoShelfConnection
1010
1011# A paginated list of videos for this user.
1012videos(
1013first: Int,
1014after: Cursor,
1015type: BroadcastType,
1016types: [BroadcastType!],
1017sort: VideoSort,
1018options: VideoConnectionOptionsInput
1019): VideoConnection
1020
1021# The viewable poll for a channel.
1022# Null if no viewable poll is present.
1023viewablePoll: Poll
1024
1025# A paginated list of viewed videos and their histories for this user.
1026# Only resolves for current user.
1027viewedVideos(first: Int): ViewedVideosConnection
1028
1029# A paginated list of channel VIPs.
1030vips(first: Int, after: Cursor): VIPConnection
1031
1032# A user's balances in their Twitch Wallet in different FIAT currencies
1033# If this isn't the `currentUser` this will return null.
1034walletBalances(
1035walletType: WalletType,
1036bestGuessCountryCode: String
1037): WalletBalances
1038
1039# A list of restrictions that prevent a user from hosting Watch Parties. A
1040# user can only host Watch Parties if there are no restrictions.
1041watchPartiesRestrictions: [WatchPartiesRestriction!]
1042
1043# A Watch Party if the User is currently broadcasting one.
1044watchParty(accessToken: String, decorated: Boolean): WatchPartyResult
1045
1046# Settings related to the Whispers (private user-to-user messaging) feature.
1047# Only resolves for the authenticated user.
1048whisperSettings: WhisperSettings
1049
1050# A paginated list of whisper threads for the current user, sorted by recent
1051# first.
1052whisperThreads(first: Int, after: Cursor): WhisperThreadConnection
1053
1054# Withholding Tax Detail is the withholding tax rates for the creator.
1055withholdingTaxDetail: WithholdingTaxDetail
1056
1057}

link Required by