GET lists/members

Updated on Wed, 2012-09-12 14:37

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

Resource URL

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

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 semi-optional

Causes the collection of list members to be broken into "pages" of somewhat consistent size. 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.

Example Values: 12893764510938

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/lists/members.json?slug=team&owner_screen_name=twitterapi&cursor=-1

  1. {
  2.   "previous_cursor": 0,
  3.   "previous_cursor_str": "0",
  4.   "next_cursor": 0,
  5.   "users": [
  6.     {
  7.       "profile_sidebar_fill_color": "bedcfa",
  8.       "expanded_url": null,
  9.       "profile_sidebar_border_color": "85add6",
  10.       "name": "Sharon Ly",
  11.       "profile_background_tile": false,
  12.       "location": "",
  13.       "profile_image_url": "http://a2.twimg.com/profile_images/1359867172/image_normal.jpg",
  14.       "created_at": "Sun May 25 00:29:44 +0000 2008",
  15.       "follow_request_sent": null,
  16.       "is_translator": false,
  17.       "profile_link_color": "955ea6",
  18.       "id_str": "14895163",
  19.       "entities": {
  20.         "urls": [
  21.  
  22.         ],
  23.         "hashtags": [
  24.  
  25.         ],
  26.         "user_mentions": [
  27.  
  28.         ]
  29.       },
  30.       "default_profile": false,
  31.       "favourites_count": 63,
  32.       "contributors_enabled": false,
  33.       "url": null,
  34.       "id": 14895163,
  35.       "utc_offset": -28800,
  36.       "profile_image_url_https": "https://si0.twimg.com/profile_images/1359867172/image_normal.jpg",
  37.       "profile_use_background_image": true,
  38.       "listed_count": 43,
  39.       "lang": "en",
  40.       "profile_text_color": "4c58a3",
  41.       "followers_count": 784,
  42.       "protected": false,
  43.       "profile_background_color": "312040",
  44.       "geo_enabled": true,
  45.       "description": "",
  46.       "time_zone": "Pacific Time (US & Canada)",
  47.       "verified": false,
  48.       "profile_background_image_url_https": "https://si0.twimg.com/profile_background_images/257176598/hydrangeas_94_68830.jpg",
  49.       "notifications": null,
  50.       "friends_count": 188,
  51.       "statuses_count": 325,
  52.       "profile_background_image_url": "http://a1.twimg.com/profile_background_images/257176598/hydrangeas_94_68830.jpg",
  53.       "default_profile_image": false,
  54.       "status": {
  55.         "coordinates": null,
  56.         "truncated": false,
  57.         "created_at": "Tue Jul 05 03:46:03 +0000 2011",
  58.         "favorited": false,
  59.         "id_str": "88091240503058432",
  60.         "in_reply_to_user_id_str": "748353",
  61.         "contributors": null,
  62.         "text": "@kmonkeyjam Oh no... I don't know where that bone is but that sounds terribly painful. How are you still tweeting? Get better!",
  63.         "id": 88091240503058432,
  64.         "retweet_count": 0,
  65.         "in_reply_to_status_id_str": "87979906226597888",
  66.         "geo": null,
  67.         "retweeted": false,
  68.         "in_reply_to_user_id": 748353,
  69.         "source": "<a href=\"http://twitter.com/#!/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
  70.         "in_reply_to_screen_name": "kmonkeyjam",
  71.         "place": null,
  72.         "in_reply_to_status_id": 87979906226597888
  73.       },
  74.       "display_url": null,
  75.       "screen_name": "onesnowclimber",
  76.       "show_all_inline_media": true,
  77.       "following": null
  78.     }
  79.   ],
  80.   "next_cursor_str": "0"
  81. }