GET lists

Updated on Sat, 2012-08-25 11:12

Returns the lists of the specified (or authenticated) user. Private lists will be included if the authenticated user is the same as the user whose lists are being returned.

Resource URL

https://api.twitter.com/1/lists.format

Parameters

user_id required

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

screen_name required

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

cursor optional

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.

Example Request

GET

https://api.twitter.com/1/lists.json?screen_name=twitterapi

  1. {
  2.   "previous_cursor": 0,
  3.   "lists": [
  4.     {
  5.       "slug": "meetup-20100301",
  6.       "name": "meetup-20100301",
  7.       "uri": "/twitterapi/meetup-20100301",
  8.       "created_at": "Sat Feb 27 21:39:24 +0000 2010",
  9.       "id_str": "8044403",
  10.       "subscriber_count": 144,
  11.       "member_count": 116,
  12.       "mode": "public",
  13.       "id": 8044403,
  14.       "full_name": "@twitterapi/meetup-20100301",
  15.       "description": "Guests attending the Twitter meetup on 1 March 2010 at the @twoffice",
  16.       "user": {
  17.         "profile_sidebar_fill_color": "DDEEF6",
  18.         "profile_background_tile": false,
  19.         "profile_sidebar_border_color": "C0DEED",
  20.         "name": "Twitter API",
  21.         "created_at": "Wed May 23 06:01:13 +0000 2007",
  22.         "profile_image_url": "http://a0.twimg.com/profile_images/2284174872/7df3h38zabcvjylnyfe3_normal.png",
  23.         "location": "San Francisco, CA",
  24.         "is_translator": false,
  25.         "id_str": "6253282",
  26.         "profile_link_color": "0084B4",
  27.         "follow_request_sent": false,
  28.         "contributors_enabled": true,
  29.         "url": "http://dev.twitter.com",
  30.         "default_profile": true,
  31.         "favourites_count": 24,
  32.         "profile_image_url_https": "https://si0.twimg.com/profile_images/2284174872/7df3h38zabcvjylnyfe3_normal.png",
  33.         "utc_offset": -28800,
  34.         "id": 6253282,
  35.         "listed_count": 10649,
  36.         "profile_use_background_image": true,
  37.         "followers_count": 1173570,
  38.         "profile_text_color": "333333",
  39.         "lang": "en",
  40.         "protected": false,
  41.         "profile_background_image_url_https": "https://si0.twimg.com/images/themes/theme1/bg.png",
  42.         "geo_enabled": true,
  43.         "time_zone": "Pacific Time (US & Canada)",
  44.         "verified": true,
  45.         "description": "The Real Twitter API. I tweet about API changes, service issues and happily answer questions about Twitter and our API. Don't get an answer? It's on my website.",
  46.         "notifications": false,
  47.         "profile_background_color": "C0DEED",
  48.         "friends_count": 31,
  49.         "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
  50.         "statuses_count": 3326,
  51.         "default_profile_image": false,
  52.         "following": false,
  53.         "screen_name": "twitterapi",
  54.         "show_all_inline_media": false
  55.       },
  56.       "following": false
  57.     },
  58.     {
  59.       "slug": "team",
  60.       "name": "team",
  61.       "uri": "/twitterapi/team",
  62.       "created_at": "Wed Nov 04 01:24:28 +0000 2009",
  63.       "id_str": "2031945",
  64.       "subscriber_count": 272,
  65.       "member_count": 19,
  66.       "mode": "public",
  67.       "id": 2031945,
  68.       "full_name": "@twitterapi/team",
  69.       "description": "",
  70.       "user": {
  71.         "profile_sidebar_fill_color": "DDEEF6",
  72.         "profile_background_tile": false,
  73.         "profile_sidebar_border_color": "C0DEED",
  74.         "name": "Twitter API",
  75.         "created_at": "Wed May 23 06:01:13 +0000 2007",
  76.         "profile_image_url": "http://a0.twimg.com/profile_images/2284174872/7df3h38zabcvjylnyfe3_normal.png",
  77.         "location": "San Francisco, CA",
  78.         "is_translator": false,
  79.         "id_str": "6253282",
  80.         "profile_link_color": "0084B4",
  81.         "follow_request_sent": false,
  82.         "contributors_enabled": true,
  83.         "url": "http://dev.twitter.com",
  84.         "default_profile": true,
  85.         "favourites_count": 24,
  86.         "profile_image_url_https": "https://si0.twimg.com/profile_images/2284174872/7df3h38zabcvjylnyfe3_normal.png",
  87.         "utc_offset": -28800,
  88.         "id": 6253282,
  89.         "listed_count": 10649,
  90.         "profile_use_background_image": true,
  91.         "followers_count": 1173570,
  92.         "profile_text_color": "333333",
  93.         "lang": "en",
  94.         "protected": false,
  95.         "profile_background_image_url_https": "https://si0.twimg.com/images/themes/theme1/bg.png",
  96.         "geo_enabled": true,
  97.         "time_zone": "Pacific Time (US & Canada)",
  98.         "verified": true,
  99.         "description": "The Real Twitter API. I tweet about API changes, service issues and happily answer questions about Twitter and our API. Don't get an answer? It's on my website.",
  100.         "notifications": false,
  101.         "profile_background_color": "C0DEED",
  102.         "friends_count": 31,
  103.         "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
  104.         "statuses_count": 3326,
  105.         "default_profile_image": false,
  106.         "following": false,
  107.         "screen_name": "twitterapi",
  108.         "show_all_inline_media": false
  109.       },
  110.       "following": false
  111.     }
  112.   ],
  113.   "previous_cursor_str": "0",
  114.   "next_cursor": 0,
  115.   "next_cursor_str": "0"
  116. }