Me

Get user info

GET /me

Get information about the currently signed in user.

Response

Field	Type	Description
Features	array	Unknown array about features the user has
Settings	settings object	User's saved settings for the player
User	user object	User information

Change user info

POST /me

Update your user information.

JSON Params

Partial user object with the changes you want to make.
At least Birthday, FirstName, GoogleMapsPlaceId, LastName and Pronouns can be changed using this endpoint.

Change settings

POST /me/settings

Set saved player settings.

JSON Params

Partial settings object with the changes you want to make.

Get player code

GET /me/player-code

Get the Private URL code for the Streaming Widget.

Response

Field	Type	Description
PlayerCode	string	The code for the Private URL

Regenerate player code

POST /me/player-code

Regenerates the Private URL code for the Streaming Widget

Change email

POST /me/email

Change your account email.

JSON Params

Field	Type	Description
NewEmail	string	The new email you want to switch to

Change password

POST /me/password

Change your password.

JSON Params

Field	Type	Description
OldPassword	string	Your old password for verification
NewPassword	string	Your new password

Enable SMS 2FA (deprecated)

POST /me/two-factor

Starts the process to enable SMS 2FA on your account.

JSON Params

Field	Type	Description
CountryCode	string	The country code of your phone number
PhoneNumber	string	The rest of your phone number

Confirm SMS 2FA (deprecated)

POST /me/two-factor/confirm

Final step in adding SMS 2FA to your account.

JSON Params

Field	Type	Description
Token	string	The token from the Authy app or text message

Disable SMS 2FA (deprecated)

POST /me/two-factor/disable

Disables SMS 2FA from your account.

Enable TOTP 2FA

POST /me/two-factor/enable-totp

Enables TOTP 2FA

Response

204 No Content

Get TOTP QR Code

GET /me/two-factor/totp-qr

Get the QR code for setting up the authenticator app

Response

A PNG image of the QR Code

Disable TOTP 2FA

POST /me/two-factor/disable-totp

Disables TOTP 2FA

Response

204 No Content

Enable Email 2FA

POST /me/two-factor/enable-email

Enables Email 2FA

Response

204 No Content

Disable Email 2FA

POST /me/two-factor/disable-email

Disables Email 2FA

Response

204 No Content

Change notifications

POST /me/notifications

Update your email subscriptions.

JSON Params

Field	Type	Description
Interests	array of strings	Emails you're interested in (news, events, merch, goldPerks)

Get licenses

GET /self/licenses

Get creator licenses.

Response

Field	Type	Description
Licenses	object	Object with the results
Licenses.Data	array of license objects	The results of the query
Licenses.Limit	integer	The limit used
Licenses.Offset	integer	The offset used
Licenses.Total	integer	The total amount of results for the search

License object

Field	Type	Description
ActiveTimes	array of objects	List of times when license was active
ActiveTimes[].CreatedAt	ISO8601 timestamp	When the license was created
ActiveTimes[].Finish	ISO8601 timestamp	When the license ran out
ActiveTimes[].GoldTimeRangeId	string	ID of the gold time range
ActiveTimes[].Id	string	ID of this time range
ActiveTimes[].LicenseId	string	ID of the license
ActiveTimes[].Source	string	The source of this license
ActiveTimes[].Start	string	When the license started
Archived	boolean	Has the license been archived
CreatedAt	ISO8601 timestamp	When the license was created
Free	boolean	Whether the license is free
FreeAt	ISO8601 timestamp	When the license became free
FreeReason	string	Reason for the license being free
HasActivePeriod	boolean	Whether the license is currently active
Id	string	ID of the license
Identity	string	Channel ID for the license
Invalid	boolean	Whether the license is invalid
LastSync	ISO8601 timestamp	The last time the license was synced
Notes?	string	Notes on the license
OauthId	string	ID of the oauth integration
Sanitized	boolean	Whether the Channel ID has been sanitized
ScheduledSync	ISO8601 timestamp	The next sync scheduled to happen
State	string	The state of the license
SyncFailures	integer	Amount of times syncing has failed
SyncState	string	The state of syncing
UpdatedAt	ISO8601 timestamp	The last time the license was updated
UserArchived	boolean	Whether the user has been archived
UserEmail	string	The owning user's email
UserId	string	The ID of the owning user
Vendor	string	YouTube or Twitch
Whitelisted	?boolean	Whether the channel has been whitelisted
YouTubeStatsDate	ISO8601 timestamp	When the YouTube stats were updated
YouTubeSubscribers	integer	Subscribers the channel has
YouTubeTitle	string	YouTube channel name
YouTubeUrl	string	URL of the YouTube channel
YouTubeViews	integer	Views the channel has

Remove license

POST /self/license/{License.Id}/delete

Deletes a creator license.

Remove video claims

POST /me/remove-claims

Release a claim from a youtube video.

JSON Params

Field	Type	Description
VideoId	string	ID or URL to the video with the claim

Generate discount code

POST /me/benefits/shop-code

Generates a merch discount code. The code can only be seen on the Shop Discounts page.