GET lists/subscribers

Updated on Thu, 2013-03-07 10:27

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

Resource URL

https://api.twitter.com/1.1/lists/subscribers.json

Parameters

Either a list_id or a slug is required. If providing a list_slug, an owner_screen_name or owner_id is also required.

list_id required

The numerical id of the list.

slug required

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.

owner_screen_name optional

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

owner_id optional

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

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.

include_entities optional

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.

skip_status optional

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

Example Request

GET

https://api.twitter.com/1.1/lists/subscribers.json?include_entities=true&cursor=-1&skip_status=true&slug=team&owner_screen_name=twitter

  1. {
  2.   "previous_cursor": 0,
  3.   "previous_cursor_str": "0",
  4.   "next_cursor": 1357643166637635702,
  5.   "users": [
  6.     {
  7.       "profile_background_tile": false,
  8.       "profile_sidebar_fill_color": "DDEEF6",
  9.       "name": "Almissen665",
  10.       "profile_sidebar_border_color": "C0DEED",
  11.       "location": null,
  12.       "profile_image_url": "http://a0.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
  13.       "created_at": "Mon Jun 27 09:17:15 +0000 2011",
  14.       "follow_request_sent": false,
  15.       "is_translator": false,
  16.       "profile_link_color": "0084B4",
  17.       "id_str": "324841714",
  18.       "url": null,
  19.       "default_profile": true,
  20.       "contributors_enabled": false,
  21.       "favourites_count": 0,
  22.       "id": 324841714,
  23.       "utc_offset": null,
  24.       "profile_image_url_https": "https://si0.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
  25.       "profile_use_background_image": true,
  26.       "listed_count": 0,
  27.       "lang": "en",
  28.       "profile_text_color": "333333",
  29.       "followers_count": 6,
  30.       "protected": false,
  31.       "profile_background_image_url_https": "https://si0.twimg.com/images/themes/theme1/bg.png",
  32.       "notifications": false,
  33.       "geo_enabled": false,
  34.       "description": null,
  35.       "profile_background_color": "C0DEED",
  36.       "time_zone": null,
  37.       "verified": false,
  38.       "statuses_count": 1,
  39.       "friends_count": 27,
  40.       "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
  41.       "default_profile_image": true,
  42.       "screen_name": "bonasser789",
  43.       "following": false,
  44.       "show_all_inline_media": false
  45.     },
  46.     {
  47.       "profile_sidebar_fill_color": "E6F6F9",
  48.       "profile_sidebar_border_color": "DBE9ED",
  49.       "name": "GR Syber-Space",
  50.       "profile_background_tile": true,
  51.       "location": "Grand Rapids, MI",
  52.       "profile_image_url": "http://a2.twimg.com/profile_images/1322547748/images__97__normal.jpg",
  53.       "created_at": "Thu Sep 30 23:05:38 +0000 2010",
  54.       "profile_link_color": "CC3366",
  55.       "id_str": "197218370",
  56.       "follow_request_sent": false,
  57.       "is_translator": false,
  58.       "url": "http://www.wix.com/castlesportsgr/myj",
  59.       "default_profile": false,
  60.       "favourites_count": 2,
  61.       "contributors_enabled": false,
  62.       "id": 197218370,
  63.       "utc_offset": -18000,
  64.       "profile_image_url_https": "https://si0.twimg.com/profile_images/1322547748/images__97__normal.jpg",
  65.       "profile_use_background_image": true,
  66.       "listed_count": 268,
  67.       "lang": "en",
  68.       "profile_text_color": "333333",
  69.       "followers_count": 2628,
  70.       "protected": true,
  71.       "notifications": false,
  72.       "geo_enabled": true,
  73.       "profile_background_color": "DBE9ED",
  74.       "description": "Welcome to Teen Gossip 411. Celebrity Gossip, Teens fashion trends for the summer 2011, Hollywood Gossip, Hotest music, Teen Websites, and more.",
  75.       "time_zone": "Quito",
  76.       "verified": false,
  77.       "profile_background_image_url_https": "https://si0.twimg.com/profile_background_images/237705957/images__97_.jpg",
  78.       "default_profile_image": false,
  79.       "friends_count": 2846,
  80.       "profile_background_image_url": "http://a2.twimg.com/profile_background_images/237705957/images__97_.jpg",
  81.       "statuses_count": 7463,
  82.       "show_all_inline_media": true,
  83.       "screen_name": "GRSYBERSPACE",
  84.       "following": false
  85.     }
  86.   ],
  87.   "next_cursor_str": "1357643166637635702"
  88. }