penicillin/blue.starry.penicillin.endpoints.lists/membersByOwnerScreenName

membersByOwnerScreenName

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

Returns the members of the specified list. Private list members 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

slug

You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.

ownerScreenName

The screen name of the user who owns the list being requested by a slug.

count

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

cursor

Causes the collection of list members to be broken into "pages" of consistent sizes (specified by the count parameter). If no cursor is provided, a value of -1 will be assumed, which is the first "page." The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.

includeEntities

The entities node will not be included when set to false.

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.