GET /2/users/:id/list_memberships
GET /2/users/:id/list_memberships
Returns all Lists a specified user is a member of.
Endpoint URL
https://api.x.com/2/users/:id/list_memberships
Authentication and rate limits
Authentication methods supported by this endpoint | OAuth 1.0a is also available for this endpoint. |
---|---|
Rate limit | User rate limit (User context): 75 requests per 15-minute window per each authenticated user App rate limit (Application-only): 75 requests per 15-minute window shared among all users of your app |
OAuth 2.0 scopes required by this endpoint
|
Learn more about OAuth 2.0 Authorization Code with PKCE |
Path parameters
Name | Type | Description |
---|---|---|
id Required | string | The user ID whose List memberships you would like to retrieve. |
Query parameters
Name | Type | Description |
---|---|---|
expansions Optional | enum (owner_id ) | 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. At this time, the only expansion available to endpoints that primarily return List objects is expansions=owner_id . You will find the expanded user data object living in the includes response object. |
list.fields Optional | enum (created_at , follower_count , member_count , private , description , owner_id ) | 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. |
max_results Optional | integer | The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results. |
pagination_token Optional | string | Used to request the next page of results if all results weren't returned with the latest request, or to go back to the previous page of results. To return the next page, pass the next_token returned in your previous response. To go back one page, pass the previous_token returned in your previous response. |
user.fields Optional | enum (created_at , description , entities , id , location , most_recent_tweet_id , name , pinned_tweet_id , profile_image_url , protected , public_metrics , url , username , verified , withheld ) | This fields parameter enables you to select which specific user fields will deliver with the users object. Specify the desired fields in a comma-separated list without spaces between commas and fields. 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. |
Example code with offical SDKs
TypeScript (Default fields)
TypeScript (Optional fields)
Java (Default fields)
Java (Optional fields)
Example responses
Default fields
Optional fields
Response fields
Name | Type | Description |
---|---|---|
id Default | string | Unique identifier of this List. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. |
name Default | string | The name of this List. |
created_at | date (ISO 8601) | Creation time of this List. To return this field, add list.fields=created_at in the request's query parameter. |
private | boolean | Indicates if this List has been set to private. The List (in other words, if this is publicly viewed or not). To return this field, add list.fields=private in the request's query parameter. |
follower_count | integer | Number of users who follow this List. To return this field, add list.fields=follower_count in the request's query parameter. |
member_count | integer | Number of users who are a member of this List. To return this field, add list.fields=member_count in the request's query parameter. |
owner_id | string | Unique identifier of this List's owner. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. To return this field, add list.fields=owner_id in the request's query parameter. |
description | string | A brief description of this List, if the owner provided one. To return this field, add list.fields=description in the request's query parameter. |
includes.users | array | When including the expansions=owner_id parameter, this includes the referenced List owner in the form of a user object with their default fields and any additional fields requested using the user.fields parameter. |
meta Default | object | This object contains information about the number of users returned in the current request, and pagination details. |
meta.result_count Default | integer | The number of users returned in this request. Note that this number may be lower than what was specified in the max_results query parameter. |
meta.previous_token | string | Pagination token for the previous page of results. This value is returned when there are multiple pages of results, as the current request may only return a subset of results. To go back to the previous page, passing the value from this field in the pagination_token query parameter. When this field is not returned in the response, it means you are on the first page of results. |
meta.next_token | string | Pagination token for the next page of results. This value is returned when there are multiple pages of results, as the current request may only return a subset of results. To retrieve the full list, keep passing the value from this field in the pagination_token query parameter. When this field is not returned in the response, it means you've reached the last page of results, and that there are no further pages. |