Addon - Get Twitch

Service:

Addons

API Version:

250704

Gets information of the Twitch addon on a title, omits secrets.

POST https://titleId.playfabapi.com/Addon/GetTwitch

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name	Type	Description
200 OK	GetTwitchResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
GetTwitchRequest
GetTwitchResponse

ApiErrorWrapper

Object

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Object

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetTwitchRequest

Object

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

GetTwitchResponse

Object

Name	Type	Description
ClientID	string	Client ID obtained after creating your Twitch developer account.
Created	boolean	Addon status.

Error Codes

Name	Code
InvalidEntityType	1373
InvalidParams	1000
InvalidTitleId	1004