/channel/subscribers

get

https://api.gamewisp.com/pub/v1/channel/subscribers

Returns a channel's subscribers based on input parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
This endpoint is paginated
Make sure to review how our Cursors work to get the most out of this call.

📘
This endpoint Accepts Include Parameters
Be sure to review how include parameters work if you haven't yet.

Include Parameters

Include Parameter	Description
user	Returns a user object nested with each subscriber object
tier	Returns a tier object nested within each subscriber object.
user,tier	Returns both the tier and user object nested within each subscriber object.

Query Params

access_token

string

required

The OAuth2 Access Token of the channel.

scope

string

required

Defaults to read_only

the read_only scope is required, and supplied by default.

include

string

Defaults to null

Allows optional information inclusion with this query. See "Documentation" section below.

limit

int32

Defaults to 10

Limit on the number of subscribers returned. Min: 1, max: 50

order

string

Defaults to desc

Ordering of the created_at date on the returned subscribers. Options: asc, desc

status

string

Defaults to all

Filter the returned subscribers by status. Options: all, active, inactive, trial, twitch, grace_period, billing_grace_period. Options can be comma separated to return records that match any of the given status fields in the query

cursor

string

Defaults to null

Used for pagination. See Response Pagination.

string

Defaults to nill

Used for pagination. See Response Pagination.

Response

/channel/subscribers

📘
This endpoint is paginated

📘
This endpoint Accepts Include Parameters

Include Parameters

📘This endpoint is paginated

📘This endpoint Accepts Include Parameters

Include Parameters

200200

📘
This endpoint is paginated

📘
This endpoint Accepts Include Parameters