lookupPinnedLists abstract method

Future<TwitterResponse<List<ListData>, ListMeta>> lookupPinnedLists({
  1. required String userId,
  2. List<ListExpansion>? expansions,
  3. List<UserField>? userFields,
  4. List<ListField>? listFields,

Returns the Lists pinned by a specified user.


  • userId: The user ID whose pinned Lists you would like to retrieve. The user’s ID must correspond to the user ID of the authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request.

  • expansions: Expansions enable you to request additional data objects that relate to the originally returned List. The ID that represents the expanded data object will be included directly in the List data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original user object.

  • userFields: This fields parameter enables you to select which specific user fields will deliver with the users object. The user fields will only be returned if you have included expansions=owner_id query parameter in your request. You will find this ID and all additional user fields in the included data object.

  • listFields: This fields parameter enables you to select which specific List fields will deliver with each returned List objects. Specify the desired fields in a comma-separated list without spaces between commas and fields. These specified List fields will display directly in the List data objects.

Endpoint Url

Authentication Methods

  • OAuth 2.0 Authorization Code with PKCE
  • OAuth 1.0a

Required Scopes

  • tweet.read
  • users.read
  • list.read

Rate Limits

  • User rate limit (OAuth 2.0 user Access Token): 15 requests per 15-minute window per each authenticated user



Future<TwitterResponse<List<ListData>, ListMeta>> lookupPinnedLists({
  required String userId,
  List<ListExpansion>? expansions,
  List<UserField>? userFields,
  List<ListField>? listFields,