penicillin/blue.starry.penicillin.endpoints.lists/subscribers

subscribers

fun Lists.subscribers(    listId: Long,     count: Int? = null,     cursor: Long? = null,     includeEntities: Boolean? = null,     skipStatus: Boolean? = null,     vararg options: Option): CursorJsonObjectApiAction<CursorUsers, User>
Content copied to clipboard

Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.

Twitter API reference

Receiver

Lists endpoint instance.

Return

CursorJsonObjectApiAction for CursorUsers model.

Parameters

listId

The numerical id of the list.

count

Specifies the number of results to return per page (see cursor below). The default is 20, with a maximum of 5,000.

cursor

Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. See Using cursors to navigate collections for more information.

includeEntities

When set to either true , t or 1 , each tweet will include a node called "entities". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. While entities are opt-in on timelines at present, they will be made a default component of output in the future. See Tweet Entities for more details.

skipStatus

When set to either true , t or 1 statuses will not be included in the returned user objects.

options

Optional. Custom parameters of this request.