list

fun Lists.list(reverse: Boolean? = null, vararg options: Option): JsonArrayApiAction<TwitterList>

Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists/ownerships and/or GET lists/subscriptions instead.

Twitter API reference

Receiver

Lists endpoint instance.

Return

JsonArrayApiAction for TwitterList model.

Parameters

reverse

Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.

options

Optional. Custom parameters of this request.


fun Lists.list(    userId: Long,     reverse: Boolean? = null,     vararg options: Option): JsonArrayApiAction<TwitterList>

Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists/ownerships and/or GET lists/subscriptions instead.

Twitter API reference

Receiver

Lists endpoint instance.

Return

JsonArrayApiAction for TwitterList model.

Parameters

userId

The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name. Note: : Specifies the ID of the user to get lists from. Helpful for disambiguating when a valid user ID is also a valid screen name.

reverse

Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.

options

Optional. Custom parameters of this request.


fun Lists.list(    screenName: String,     reverse: Boolean? = null,     vararg options: Option): JsonArrayApiAction<TwitterList>

Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists/ownerships and/or GET lists/subscriptions instead.

Twitter API reference

Receiver

Lists endpoint instance.

Return

JsonArrayApiAction for TwitterList model.

Parameters

screenName

The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.

reverse

Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.

options

Optional. Custom parameters of this request.


val Lists.list: JsonArrayApiAction<TwitterList>

Shorthand property to Lists.list.

See also