Twitter

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List to which the user will be added.

• user_idstringObligatorio

  Unique identifier of the User to add to the list. If you have a username, convert it to a `user_id` first (e.g., via GET /2/users/by/username/{username}).

Parámetros de salida

• dataobjectObligatorio

  The main response body containing either the operation's success data or error information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The user ID of the authenticated user making the request. This ID is used as a path parameter to specify whose bookmark collection the Tweet will be added to.

• tweet_idstringObligatorio

  Unique identifier (string) of the Tweet to be bookmarked, provided in the request body. String type used to support large integer values.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API, encapsulating the outcome of the bookmark operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the authenticated User whose bookmarks are to be retrieved. This ID must correspond to the user whose credentials are used for the API request.

• expansionsstring[]

  A list of objects to expand and include in the response, providing more detailed information about entities like authors, media, or referenced Tweets. Refer to the `ExpansionsEnm0` enum for available expansion options.

• max_resultsinteger

  The maximum number of bookmarked Tweets to return per page, between 1 and 100 inclusive.

• poll__fieldsstring[]

  A list of specific Poll object fields to include when `attachments.poll_ids` is part of `expansions`. Refer to the `PollFieldsEnm0` enum for available field options.

• user__fieldsstring[]

  A list of specific User object fields to include for user objects (e.g., authors) when requested via `expansions`. Refer to the `UserFieldsEnm0` enum for available field options.

• media__fieldsstring[]

  A list of specific Media object fields to include when `attachments.media_keys` is part of `expansions`. Refer to the `MediaFieldsEnm0` enum for available field options.

• place__fieldsstring[]

  A list of specific Place object fields to include when `geo.place_id` is part of `expansions`. Refer to the `PlaceFieldsEnm0` enum for available field options.

• tweet__fieldsstring[]

  A list of specific Tweet fields to include in the response for each bookmarked Tweet. Omitting this parameter will result in a default set of fields being returned. Refer to the `TweetFieldsEnm0` enum for available field options.

• pagination_tokenstring

  A token used for pagination. This token is obtained from the `next_token` field in a previous response, allowing you to fetch the subsequent page of bookmarked Tweets. If omitted, the first page of results is returned.

Parámetros de salida

• dataobjectObligatorio

  The main response payload containing the list of bookmarked Tweets, included objects, pagination metadata, and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• messageobjectObligatorio

  A JSON object representing the initial message for the DM conversation. It must contain a 'text' field for the message content, and can optionally include an 'attachments' field for media (e.g., `attachments: [{"media_id": "media_id_string"}]`).

• participant_idsstring[]Obligatorio

  A list of Twitter User IDs for the participants to be included in the group DM conversation. The authenticated user is implicitly included.

• conversation_typestringObligatorioenum

  Specifies the type of conversation to be created. Must be 'Group' for this action.

  Group

Parámetros de salida

• dataobjectObligatorio

  Contains the details of the newly created Direct Message conversation, including its ID and the ID of the initial event (message).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  Optional. A user-defined name for the compliance job. Must be unique and up to 64 characters.

• typestringObligatorioenum

  Type of compliance job: 'tweets' for Tweet IDs or 'users' for user IDs.

  tweetsusers
• resumableboolean

  If true, returns a pre-signed URL for resumable uploads, useful for large ID lists. Defaults to false if not specified.

Parámetros de salida

• dataobjectObligatorio

  Details of the created compliance job or errors encountered.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the List (1-25 characters, must start with a letter, and can only contain letters, numbers, hyphens, or underscores).

• privateboolean

  Sets List visibility: True for private, False for public.

• descriptionstring

  Brief description for the List (up to 100 characters).

Parámetros de salida

• dataobjectObligatorio

  Response data, including created List details or errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  Text content of the Tweet (max 280 characters). Required unless `card_uri`, `media_media_ids`, `poll_options`, or `quote_tweet_id` are provided.

• card_uristring

  URI of a card to attach. Mutually exclusive with `quote_tweet_id`, `poll` parameters, `media` parameters, and `direct_message_deep_link`.

• nullcastboolean

  Marks the Tweet as a promoted-only post, not appearing in public timelines or served to followers.

• poll__optionsstring[]

  List of 2 to 4 poll options (max 25 characters each). Required if creating a poll. Mutually exclusive with `card_uri`.

• geo__place__idstring

  Twitter Place ID to associate with the Tweet.

• quote_tweet_idstring

  ID of the Tweet to quote. Mutually exclusive with `card_uri`, `poll` parameters, and `direct_message_deep_link`.

• reply_settingsstringenum

  Specifies who can reply to this Tweet: 'following', 'mentionedUsers', or 'subscribers' (X Premium subscribers).

  followingmentionedUserssubscribers
• media__media__idsstring[]

  Up to 4 Media IDs obtained from prior uploads. Mutually exclusive with `card_uri`.

• poll__reply__settingsstringenum

  Specifies who can reply to the poll Tweet: 'following' or 'mentionedUsers'. Mutually exclusive with `card_uri`.

  followingmentionedUsers
• poll__duration__minutesinteger

  Poll duration in minutes (5-10080). Required if `poll_options` are provided. Mutually exclusive with `card_uri`.

• direct_message_deep_linkstring

  Deep link to a private Direct Message conversation. Mutually exclusive with `card_uri`.

• for_super_followers_onlyboolean

  Restricts Tweet visibility to the author's Super Followers.

• media__tagged__user__idsstring[]

  User IDs to tag in media; tagged users must have enabled photo tagging. Mutually exclusive with `card_uri`.

• reply__in__reply__to__tweet__idstring

  ID of the Tweet to which this is a reply. Required if creating a reply.

• reply__exclude__reply__user__idsstring[]

  User IDs to exclude from @mentioning in the reply; these users will not be notified. Used when `reply_in_reply_to_tweet_id` is set.

Parámetros de salida

• dataobjectObligatorio

  The main response data, containing either the created Tweet information or error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• event_idstringObligatorio

  The unique identifier of the Direct Message event to be deleted.

Parámetros de salida

• dataobjectObligatorio

  The response payload from the DM event deletion request. Contains either a confirmation of deletion within a 'data' object, or error details within an 'errors' list.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Contains data for a successful deletion or error details if the operation failed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List.

• expansionsstring[]

  A list of fields to expand for each user, such as `pinned_tweet_id` to include the user's pinned Tweet. If an expansion is included, `tweet.fields` can be used to specify which Tweet fields are returned.

• max_resultsinteger

  The maximum number of list members to return per page. Values can range from 1 to 100.

• user__fieldsstring[]

  Specifies which additional user details to return for each list member.

• tweet__fieldsstring[]

  A list of Tweet fields to be included if an expansion like `pinned_tweet_id` or `most_recent_tweet_id` is requested. This specifies what details of the expanded Tweet should be returned.

• pagination_tokenstring

  Token for fetching a specific page of results. Obtained from the `next_token` or `previous_token` field in the response's `meta` object.

Parámetros de salida

• dataobjectObligatorio

  The main response data containing the list members, any included expansions, errors, and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Space for which to retrieve the list of ticket buyers.

• expansionsstring[]

  Objects to expand in the response for more detailed information (e.g., `pinned_tweet_id` to include the full Tweet object).

• max_resultsinteger

  Maximum number of buyer records to return per page.

• user__fieldsstring[]

  User fields to include for each buyer, providing additional details. Refer to the User object schema for available fields.

• tweet__fieldsstring[]

  Tweet fields to include when Tweet objects are expanded. Refer to the Tweet object schema for available fields.

• pagination_tokenstring

  Token from a previous response to fetch the subsequent page of results.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing the list of ticket buyers, included data (if any expansions were requested), and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Identifier of the user performing the follow; must correspond to the authenticated user context.

• list_idstringObligatorio

  Unique identifier of the Twitter List to be followed.

Parámetros de salida

• dataobjectObligatorio

  Structured response detailing the outcome of the follow operation or any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the User to lookup.

• expansionsstring[]

  A comma separated list of fields to expand.

• max_resultsinteger

  The maximum number of results.

• user__fieldsstring[]

  A comma separated list of User fields to display.

• tweet__fieldsstring[]

  A comma separated list of Tweet fields to display.

• pagination_tokenstring

  Token for paginating results.

Parámetros de salida

• dataobjectObligatorio

  The response schema

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter User whose following list is to be retrieved.

• expansionsstring[]

  Objects to expand (e.g., `pinned_tweet_id`) to include related data alongside user information.

• max_resultsinteger

  The maximum number of users to return per page, typically between 1 and 1000. Defaults to 100 if not specified.

• user__fieldsstring[]

  User fields to include for each followed user, providing additional details.

• tweet__fieldsstring[]

  Tweet fields to include for expanded tweet-related objects (e.g., `pinned_tweet_id`).

• pagination_tokenstring

  A token obtained from the `next_token` field in a previous response, used to fetch the next page of results. Omit for the first page.

Parámetros de salida

• dataobjectObligatorio

  The main payload of the response, containing the list of followed users, pagination metadata, and any included expansions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The User ID of the authenticated user initiating the follow request. This corresponds to the source user ID in the endpoint path `/2/users/{id}/following`.

• target_user_idstringObligatorio

  The unique identifier of the User to be followed. This ID is a numeric string with 1 to 19 digits, provided as a string to avoid issues with large integer handling in various languages and tools.

Parámetros de salida

• dataobjectObligatorio

  Contains the structured response from the follow user action, including either the follow status or error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  The search query or rule to match Tweets. Maximum length varies; refer to Twitter API documentation for details (e.g., https://t.co/rulelength).

• end_timestring

  The newest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) to which Tweets will be provided. Exclusive. Example: '2021-01-31T23:59:59Z'.

• since_idstring

  Returns results with a Tweet ID numerically greater (more recent) than the specified ID.

• until_idstring

  Returns results with a Tweet ID numerically less (older) than the specified ID.

• expansionsstring[]

  Specifies which objects to expand in the response for more details.

• next_tokenstring

  A token obtained from a previous response to retrieve the next page of results. Do not modify this value.

• sort_orderstringenum

  Specifies the order in which to return results. 'recency' returns the most recent Tweets first, 'relevancy' returns Tweets based on relevance.

  recencyrelevancy
• start_timestring

  The oldest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) from which Tweets will be provided. Inclusive. Example: '2021-01-01T00:00:00Z'.

• max_resultsinteger

  The maximum number of search results to return per request. Values can be between 10 and the limit defined by the API (typically 100 or 500).

• poll__fieldsstring[]

  Specifies which poll fields to include if 'attachments.poll_ids' is expanded.

• user__fieldsstring[]

  Specifies which user fields to include if 'author_id' or other user-related expansions are used.

• media__fieldsstring[]

  Specifies which media fields to include if 'attachments.media_keys' is expanded.

• place__fieldsstring[]

  Specifies which place fields to include if 'geo.place_id' is expanded.

• tweet__fieldsstring[]

  Specifies which Tweet fields to include in the response.

• pagination_tokenstring

  Alternative to 'next_token' for paginating through results. Token from a previous response for the next page. Do not modify.

Parámetros de salida

• dataobjectObligatorio

  The main response payload containing search results, included objects, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search query for matching Tweets using Twitter's V2 filtering syntax (see official Twitter API documentation for syntax and length).

• end_timestring

  Newest UTC timestamp (exclusive, YYYY-MM-DDTHH:mm:ssZ) to count Tweets up to. If specified, `start_time` is also required and `end_time` must be later.

• since_idstring

  Count Tweets more recent than this ID. Cannot be used with `start_time` or `end_time`.

• until_idstring

  Count Tweets older than this ID. Cannot be used with `start_time` or `end_time`.

• next_tokenstring

  Token from a previous response to fetch the next page of results. Use as-is.

• start_timestring

  Oldest UTC timestamp (inclusive, YYYY-MM-DDTHH:mm:ssZ) to count Tweets from. If specified, `end_time` is also required and `start_time` must be earlier.

• granularitystringenum

  Time period granularity for aggregating search count results.

  dayhourminute
• pagination_tokenstring

  Pagination token, typically `next_token` in Twitter API v2. Use as-is.

• search__count__fieldsstring[]

  Specifies which fields to return for each search count object; default fields are returned if unspecified.

Parámetros de salida

• dataobjectObligatorio

  Structured response with Tweet counts, errors, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the target User whose List memberships are to be retrieved.

• expansionsstring[]

  A list of objects to be expanded in the response, providing additional related data. For example, expanding `owner_id` includes the full User object for the list owner. Each item must be a value from `ExpansionsEnm0`.

• max_resultsinteger

  Specifies the maximum number of List memberships to return in a single page. Valid range: 1-100. Default: 100.

• list__fieldsstring[]

  A list specifying the desired fields to be returned for each List object. Each item in the list must be a value from `ListFieldsEnm0`. If omitted, default fields are returned.

• user__fieldsstring[]

  A list specifying the desired fields for User objects, applicable if `owner_id` is included in `expansions`. Each item in the list must be a value from `UserFieldsEnm0`. If omitted, default fields are returned for expanded User objects.

• pagination_tokenstring

  Token for pagination, used to fetch a specific page of results. Obtain this from the `next_token` field in a previous response to get the next page.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing the list memberships, included objects (if requested via expansions), and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  User ID of the Twitter User whose owned Lists are to be retrieved.

• expansionsstring[]

  Set to `['owner_id']` to include the User object of the List's owner.

• max_resultsinteger

  Maximum number of List results per page. Allowed values: 1-100. Default: 100.

• list__fieldsstring[]

  Specific fields to return for each List object (e.g., `created_at`, `description`).

• user__fieldsstring[]

  Specific fields for User objects if `expansions` includes `owner_id` (e.g., `username`, `public_metrics`).

• pagination_tokenstring

  Token from `meta.next_token` of a previous response to fetch the next page. Omit for the first page.

Parámetros de salida

• dataobjectObligatorio

  Contains the primary data of the response, including the list of owned Lists, any expanded objects (like users), and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the User whose pinned Lists are to be retrieved.

• expansionsstring[]

  A comma-separated list of object IDs to expand in the response, providing full details instead of just an ID. Select from `ExpansionsEnm0` to include related objects like the list owner.

• list__fieldsstring[]

  A comma-separated list of List fields to return for each List object. Select desired fields from `ListFieldsEnm0`.

• user__fieldsstring[]

  A comma-separated list of User fields to return. This is applicable when `expansions` includes `owner_id`. Select desired fields from `UserFieldsEnm0`.

Parámetros de salida

• dataobjectObligatorio

  The API response payload containing the retrieved pinned Lists, any errors, included expansions (if requested), and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  User ID of the Twitter account whose block list is requested; this ID must correspond to an existing user.

• expansionsstring[]

  Related objects to expand and include, like `pinned_tweet_id` for full Tweet objects. Sent as a comma-separated string to the API.

• max_resultsinteger

  Maximum number of blocked users per page (1-100). API defaults to 100 if unspecified.

• user__fieldsstring[]

  User fields to include for each blocked user. Sent as a comma-separated string to the API (e.g., 'created_at,description').

• tweet__fieldsstring[]

  Fields to include for expanded Tweet objects (e.g., via `expansions=pinned_tweet_id`). Sent as a comma-separated string to the API.

• pagination_tokenstring

  Token for fetching the next page of results, obtained from `meta.next_token` of a previous response.

Parámetros de salida

• dataobjectObligatorio

  Main data payload: list of blocked users, errors, includes, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• event_idstringObligatorio

  The unique identifier of the Direct Message event to retrieve.

• expansionsstring[]

  Related objects to expand and include in the response.

• user__fieldsstring[]

  User fields to include for user objects in the response.

• media__fieldsstring[]

  Media fields to include for media objects in the response.

• tweet__fieldsstring[]

  Tweet fields to include for tweet objects in the response.

• dm__event__fieldsstring[]

  DmEvent fields to include in the response.

Parámetros de salida

• dataobjectObligatorio

  The main data object containing the requested DM event and any included expansions or errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• expansionsstring[]

  Objects to expand and include. E.g., `sender_id` includes the full User object for each DM sender.

• event_typesstring[]

  DM event types to include. If unspecified, all types are returned.

• max_resultsinteger

  Maximum DM events per page (1-100).

• user__fieldsstring[]

  Fields for User objects if `expansions` includes `sender_id` or `participant_ids`. Default: basic user fields.

• media__fieldsstring[]

  Fields for Media objects if `expansions` includes `attachments.media_keys`. Default: basic media fields.

• tweet__fieldsstring[]

  Fields for Tweet objects if `expansions` includes `referenced_tweets.id`. Default: basic tweet fields.

• participant_idstringObligatorio

  User ID of the other participant in the one-to-one DM conversation.

• pagination_tokenstring

  Token from `meta.next_token` or `meta.previous_token` of a prior response to fetch a specific results page.

• dm__event__fieldsstring[]

  Fields for each DM event object. Default: 'id', 'event_type'.

Parámetros de salida

• dataobjectObligatorio

  Main response with DM events, included objects (if expansions requested), errors (if any), and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the Twitter List for which to retrieve followers.

• expansionsstring[]

  Fields to expand for more detailed information on related entities (e.g., pinned tweets, affiliated users).

• max_resultsinteger

  Maximum number of user results per page.

• user__fieldsstring[]

  User fields to include in the response for additional details on each follower.

• tweet__fieldsstring[]

  Tweet fields to include if tweet objects (e.g., pinned_tweet_id) are expanded.

• pagination_tokenstring

  Pagination token from a previous response's `next_token` to retrieve the next page.

Parámetros de salida

• dataobjectObligatorio

  Main response payload: list of followers, included objects, errors, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The User ID of the authenticated user whose muted users are to be retrieved. This ID must correspond to an existing X user.

• expansionsstring[]

  A comma-separated list of fields to expand for related objects in the response, providing more detailed information. For example, `pinned_tweet_id` can be expanded to include the full Tweet object.

• max_resultsinteger

  The maximum number of user objects to return per page. Default is 100, minimum is 1, maximum is 1000.

• user__fieldsstring[]

  A comma-separated list of user fields to include in the response. These fields provide additional information about the muted user objects (e.g., `created_at`, `description`).

• tweet__fieldsstring[]

  A comma-separated list of Tweet fields to include for any expanded Tweet objects (e.g., if `pinned_tweet_id` is in `expansions`). This is only relevant if Tweet objects are being expanded.

• pagination_tokenstring

  A token obtained from a previous response, used to fetch the next page of results. If not provided, the first page is returned.

Parámetros de salida

• dataobjectObligatorio

  The main payload of the response, containing the list of muted users, any errors, included expansions, and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Post (Tweet) for which to retrieve retweeting users. This ID must be for an existing public Post.

• expansionsstring[]

  Objects to expand and include, such as pinned Tweets of retweeters.

• max_resultsinteger

  Maximum number of user objects per page (1-100, default 100).

• user__fieldsstring[]

  User fields to include for each user who retweeted the Post.

• tweet__fieldsstring[]

  Tweet fields for expanded Tweet objects (e.g., when `expansions` includes 'pinned_tweet_id').

• pagination_tokenstring

  A token obtained from a previous response's `meta.next_token` field, used to fetch the next page of results. If not provided, the first page is returned.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing the list of users who retweeted the specified Post, along with any included expansions and metadata for pagination.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• expansionsstring[]

  A comma separated list of fields to expand.

• event_typesstring[]

  The set of event_types to include in the results.

• max_resultsinteger

  The maximum number of results.

• user__fieldsstring[]

  A comma separated list of User fields to display.

• media__fieldsstring[]

  A comma separated list of Media fields to display.

• tweet__fieldsstring[]

  A comma separated list of Tweet fields to display.

• pagination_tokenstring

  This parameter is used to get a specified "page" of results.

• dm__event__fieldsstring[]

  A comma separated list of DmEvent fields to display.

Parámetros de salida

• dataobjectObligatorio

  The response schema

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the User whose followed lists are to be retrieved.

• expansionsstring[]

  A list of objects to expand and include in the response. Use `owner_id` to include the User object of the list's owner. Refer to `ExpansionsEnm0` for available options.

• max_resultsinteger

  The maximum number of List results to be returned per page. Default is 100.

• list__fieldsstring[]

  A list of fields to include for each List object in the response. Refer to `ListFieldsEnm0` for all available fields.

• user__fieldsstring[]

  A list of fields to include for each User object, applicable if `expansions` includes `owner_id`. Refer to `UserFieldsEnm0` for available fields.

• pagination_tokenstring

  A token used to retrieve a specific page of results. This value is obtained from the `next_token` field in the `meta` object of a previous response. Use it to navigate through paginated results.

Parámetros de salida

• dataobjectObligatorio

  The full response payload. This includes the primary data (list of followed lists), pagination metadata (`meta`), any included expansions (`includes`), and potential errors (`errors`).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• hiddenbooleanObligatorio

  Set to `true` to hide the reply, `false` to unhide.

• tweet_idstringObligatorio

  Unique identifier of the reply Tweet to hide or unhide.

Parámetros de salida

• dataobjectObligatorio

  Result of the hide/unhide operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List to retrieve. This is a numeric string representing the List ID.

• expansionsstring[]

  A list of objects to expand in the response. Currently, the only supported expansion is `owner_id`, which, if included, returns the full User object for the list's owner within an `includes` object in the response.

• list__fieldsstring[]

  A list of fields to be returned for the List object. Valid fields include `created_at`, `description`, `follower_count`, `id`, `member_count`, `name`, `owner_id`, and `private`. If unspecified, default fields are returned.

• user__fieldsstring[]

  A list of fields to be returned for User objects if `owner_id` is specified in `expansions`. Valid fields include attributes like `id`, `name`, `username`, `created_at`, `description`, `public_metrics`, etc. If unspecified, default fields are returned for User objects.

Parámetros de salida

• dataobjectObligatorio

  The main response payload which includes the List data, any errors, and included objects.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Post (Tweet) for which to retrieve liking users.

• expansionsstring[]

  Fields to expand for related objects, like a user's pinned Tweet. Example: ['pinned_tweet_id'].

• max_resultsinteger

  The maximum number of user objects to return per page. The value must be between 1 and 100, inclusive. Defaults to 100 if not specified.

• user__fieldsstring[]

  User fields to retrieve for each liking user. Example: ['created_at', 'description'].

• tweet__fieldsstring[]

  Tweet fields to retrieve for expanded Tweet objects (e.g., if `expansions` includes `pinned_tweet_id`). Example: ['created_at', 'public_metrics'].

• pagination_tokenstring

  A token used to request the next page of results if more results are available. This token is returned in the `meta.next_token` field of a previous response.

Parámetros de salida

• dataobjectObligatorio

  Contains the primary data of the response, including a list of user objects who liked the post, any errors, included objects (like expanded tweets or user details), and metadata for pagination.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List from which to retrieve Tweets.

• expansionsstring[]

  Specifies which related objects to expand and include in the response (e.g., author data, media details).

• max_resultsinteger

  The maximum number of Tweets to return per request.

• poll__fieldsstring[]

  Specifies which Poll object fields to include if 'attachments.poll_ids' is in 'expansions'.

• user__fieldsstring[]

  Specifies which User object fields to include if 'author_id' or other user references are in 'expansions'.

• media__fieldsstring[]

  Specifies which Media object fields to include if 'attachments.media_keys' is in 'expansions'.

• place__fieldsstring[]

  Specifies which Place object fields to include if 'geo.place_id' is in 'expansions'.

• tweet__fieldsstring[]

  Specifies which Tweet object fields to include in the response.

• pagination_tokenstring

  A token used to request the next page of results if more Tweets are available. Obtained from the 'next_token' field in a previous response.

Parámetros de salida

• dataobjectObligatorio

  The main response payload containing the list of Tweets, any included related objects (if expanded), error information, and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The User ID of the authenticated user performing the mute action.

• target_user_idstringObligatorio

  The User ID of the user to be muted.

Parámetros de salida

• dataobjectObligatorio

  Structured API response containing either success data or error information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the authenticated User pinning the List.

• list_idstringObligatorio

  The unique identifier of the List to be pinned.

Parámetros de salida

• dataobjectObligatorio

  Response payload containing the pin status or any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Tweet to be deleted. This ID must correspond to a Tweet authored by the authenticated user.

Parámetros de salida

• dataobjectObligatorio

  The main payload of the response. It contains either a confirmation of the Tweet's deletion or details about errors that occurred during the process.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Tweet to retrieve.

• expansionsstring[]

  Additional data related to the Tweet to include, such as author details, mentioned users, or media information.

• poll__fieldsstring[]

  Poll attributes to include if poll objects are part of the Tweet or expansions.

• user__fieldsstring[]

  User attributes to include for user objects (e.g., author, mentions) requested via expansions.

• media__fieldsstring[]

  Media attributes to include if media objects are part of the Tweet or expansions.

• place__fieldsstring[]

  Place attributes to include if place objects are part of the Tweet or expansions.

• tweet__fieldsstring[]

  Tweet attributes to include for additional details about the Tweet.

Parámetros de salida

• dataobjectObligatorio

  Contains the requested Tweet data, any expansions, and errors if they occurred.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]Obligatorio

  A list of Post IDs to retrieve. Up to 100 IDs can be specified in a single request.

• expansionsstring[]

  A comma-separated list of fields to expand in the response for related entities like authors or media.

• poll__fieldsstring[]

  A comma-separated list of Poll fields to include for poll attachments.

• user__fieldsstring[]

  A comma-separated list of User fields to include for user objects.

• media__fieldsstring[]

  A comma-separated list of Media fields to include for media attachments.

• place__fieldsstring[]

  A comma-separated list of Place fields to include for geo-tagged Tweets.

• tweet__fieldsstring[]

  A comma-separated list of Tweet fields to include in the response.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing Tweet data, included objects, and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• end_timestring

  Latest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) at which the stream will automatically close, ceasing event transmission.

• start_timestring

  Earliest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) from which to start streaming label events; disregards `backfill_minutes` if provided.

• backfill_minutesinteger

  Number of minutes of historical data (labels applied or removed) to stream upon connection for recent activity; ignored if `start_time` is provided.

Parámetros de salida

• dataobjectObligatorio

  The response payload, which is either a tweet label event or an error object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• daysinteger

  Specifies the number of days (1 to 90) to retrieve usage data for. Defaults to 7 days.

• usage__fieldsstring[]

  A list of specific usage metrics to retrieve. Available fields include: 'cap_reset_day', 'daily_client_app_usage', 'daily_project_usage', 'project_cap', 'project_id', 'project_usage'. If omitted, all available usage fields are returned.

Parámetros de salida

• dataobjectObligatorio

  The complete response from the API, containing either the usage data in the 'data' field or error details in the 'errors' field of the nested Model object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search query/filter for matching Tweets (refer to X's developer documentation for syntax).

• end_timestring

  Newest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) for results; exclusive.

• since_idstring

  Returns Tweets more recent than this ID; cannot be used with `start_time`.

• until_idstring

  Returns Tweets older than this ID; cannot be used with `end_time`.

• expansionsstring[]

  Objects to expand and include in the `includes` field of the response.

• next_tokenstring

  Token from `meta.next_token` of a previous response for pagination; do not modify.

• sort_orderstringenum

  Order of results: 'recency' (most recent first) or 'relevancy'.

  recencyrelevancy
• start_timestring

  Oldest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) for results; inclusive.

• max_resultsinteger

  Maximum search results per page BETWEEN (10-100).

• poll__fieldsstring[]

  Poll fields to include if `attachments.poll_ids` is in `expansions`.

• user__fieldsstring[]

  User fields to include if user-related IDs are in `expansions`.

• media__fieldsstring[]

  Media fields to include if `attachments.media_keys` is in `expansions`.

• place__fieldsstring[]

  Place fields to include if `geo.place_id` is in `expansions`.

• tweet__fieldsstring[]

  Tweet fields to include; maps to `tweet.fields` query parameter.

• pagination_tokenstring

  Alternative pagination token from a previous `meta.next_token`; `next_token` is preferred if both are provided.

Parámetros de salida

• dataobjectObligatorio

  The main response payload containing Tweets, included objects, errors, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  A search query rule to match against Tweets. For example, '#twitterdev OR @twitterapi'. Refer to Twitter's documentation for query syntax and maximum length: https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query

• end_timestring

  The newest UTC timestamp (exclusive) to which to count Tweets, formatted as YYYY-MM-DDTHH:mm:ssZ. Must be within the last 7 days. Example: '2022-01-02T00:00:00Z'.

• since_idstring

  Returns counts for Tweets created more recently than the specified Tweet ID. This helps to paginate results chronologically.

• until_idstring

  Returns counts for Tweets created older than the specified Tweet ID. This helps to paginate results chronologically.

• next_tokenstring

  A token obtained from a previous response to fetch the next page of results. Do not modify this value.

• start_timestring

  The oldest UTC timestamp (inclusive) from which to count Tweets, formatted as YYYY-MM-DDTHH:mm:ssZ. Must be within the last 7 days. Example: '2022-01-01T00:00:00Z'.

• granularitystringenum

  The time period granularity for aggregating search counts.

  dayhourminute
• pagination_tokenstring

  A token used for pagination to retrieve the next set of results. This value is obtained from the 'next_token' field in a previous response.

• search__count__fieldsstring[]

  A list of fields to include in each search count object. Available fields: 'end', 'start', 'tweet_count'. If unspecified, default fields are returned.

Parámetros de salida

• dataobjectObligatorio

  The structured API response containing Tweet counts, metadata, and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the authenticated user whose bookmark is to be removed.

• tweet_idstringObligatorio

  The ID of the Tweet to be removed from the user's bookmarks.

Parámetros de salida

• dataobjectObligatorio

  Main response with the bookmark removal result or any errors. Check `data.data.bookmarked` for success, or `data.errors` for issues.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List from which a member will be removed.

• user_idstringObligatorio

  The unique identifier (ID) of the Twitter user to be removed from the specified List.

Parámetros de salida

• dataobjectObligatorio

  The response payload which includes either the operation's success data (confirming removal) or error details if the operation failed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Compliance Job to retrieve.

• compliance__job__fieldsstring[]

  Specifies fields for the ComplianceJob object in the response; if omitted, a default set is returned.

Parámetros de salida

• dataobjectObligatorio

  The response payload which contains the details of the requested compliance job or errors if the request failed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestringObligatorioenum

  Specifies the type of compliance job to retrieve (tweets or users).

  tweetsusers
• statusstringenum

  Filters compliance jobs by status; if omitted, jobs of all statuses for the specified type are returned.

  completecreatedfailedin_progress
• compliance__job__fieldsstring[]

  Specific `ComplianceJob` fields to include in the response; if omitted, a default set of fields is returned.

Parámetros de salida

• dataobjectObligatorio

  Contains the list of compliance jobs, potential errors, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The DM Conversation ID.

• expansionsstring[]

  A comma separated list of fields to expand.

• event_typesstring[]

  The set of event_types to include in the results.

• max_resultsinteger

  The maximum number of results.

• user__fieldsstring[]

  A comma separated list of User fields to display.

• media__fieldsstring[]

  A comma separated list of Media fields to display.

• tweet__fieldsstring[]

  A comma separated list of Tweet fields to display.

• pagination_tokenstring

  This parameter is used to get a specified "page" of results.

• dm__event__fieldsstring[]

  A comma separated list of DmEvent fields to display.

Parámetros de salida

• dataobjectObligatorio

  The response schema

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter Space from which to retrieve Tweets.

• expansionsstring[]

  A list of fields to expand and include additional related objects in the response, such as author details or media attachments. Expanded objects are returned in the 'includes' section of the response.

• max_resultsinteger

  The maximum number of Tweets to fetch from the Space per request. Defaults to 100, which is also the maximum allowed.

• poll__fieldsstring[]

  A list of Poll fields to be included for polls, if 'attachments.poll_ids' is part of 'expansions'.

• user__fieldsstring[]

  A list of User fields to be included for user objects, if 'author_id' or other user-related fields are part of 'expansions'.

• media__fieldsstring[]

  A list of Media fields to be included for media content, if 'attachments.media_keys' is part of 'expansions'.

• place__fieldsstring[]

  A list of Place fields to be included for geo-tagged Tweets, if 'geo.place_id' is part of 'expansions'.

• tweet__fieldsstring[]

  A list of Tweet fields to be included in the response. By default, only 'id' and 'text' are returned for each Tweet.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, containing Tweets and related information from the specified Space.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the Tweet whose quoting Tweets you would like to retrieve.

• excludestring[]

  Specifies whether to exclude replies or retweets from the results.

• expansionsstring[]

  Fields to expand in the response, such as 'author_id' to include the author's user object.

• max_resultsinteger

  Maximum number of results to return per page (range: 10-100).

• poll__fieldsstring[]

  Specific Poll fields to include in the response if poll objects are present.

• user__fieldsstring[]

  Specific User fields to include if user objects are present (e.g., through expansions).

• media__fieldsstring[]

  Specific Media fields to include in the response if media objects are present.

• place__fieldsstring[]

  Specific Place fields to include in the response if place objects are present.

• tweet__fieldsstring[]

  Specific Tweet fields to include in the response.

• pagination_tokenstring

  Token for retrieving a specific page of results, typically the `next_token` from a previous response.

Parámetros de salida

• dataobjectObligatorio

  The response containing quote Tweets and related data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Tweet for which to retrieve Retweets.

• expansionsstring[]

  Specifies objects to expand for related data on Retweeting Tweets or their authors (e.g., `author_id`, `referenced_tweets.id`).

• max_resultsinteger

  Specifies the maximum number of Retweets to return, between 10 and 100.

• poll__fieldsstring[]

  Poll fields to include if `expansions` contains `attachments.poll_ids`.

• user__fieldsstring[]

  User fields for authors of Retweeting Tweets, applicable if `expansions` includes `author_id`.

• media__fieldsstring[]

  Media fields to include if `expansions` contains `attachments.media_keys`.

• place__fieldsstring[]

  Place fields to include if `expansions` contains `geo.place_id`.

• tweet__fieldsstring[]

  Specifies Tweet fields to include for additional information about the Retweeting Tweets.

• pagination_tokenstring

  Pagination token from a previous response's `meta.next_token` to request the next page of results.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing the list of Retweets, included objects, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Twitter user ID whose liked Tweets are to be retrieved.

• expansionsstring[]

  Objects to expand, e.g., `author_id`, `attachments.media_keys`, for richer data.

• max_resultsinteger

  Maximum liked Tweets per page (5-100). API defaults to 10 if omitted.

• poll__fieldsstring[]

  Poll fields to include when `attachments.poll_ids` is in `expansions`.

• user__fieldsstring[]

  User fields for Tweet authors or other user objects when `expansions` includes them.

• media__fieldsstring[]

  Media fields to include when `attachments.media_keys` is in `expansions`.

• place__fieldsstring[]

  Place fields to include when `geo.place_id` is in `expansions`.

• tweet__fieldsstring[]

  Specific Tweet fields to include. API provides a default set if omitted.

• pagination_tokenstring

  Token from a previous response to fetch the next page.

Parámetros de salida

• dataobjectObligatorio

  Contains the main data of the response, including the list of liked Tweets and any included expansions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The OpenAPI specification for Twitter's API v2 in JSON format, detailing API structure (endpoints, operations, schemas).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the user performing the retweet.

• tweet_idstringObligatorio

  The ID of the Tweet to be retweeted.

Parámetros de salida

• dataobjectObligatorio

  The response payload which includes either a confirmation of the retweet or error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  The text query to search for in Space titles and descriptions.

• statestringenum

  Filters Spaces by their state (e.g., 'live', 'scheduled').

  alllivescheduled
• expansionsstring[]

  Specifies fields to expand and include additional related objects (e.g., 'creator_id' for User object, 'host_ids', 'invited_user_ids', 'speaker_ids', 'topic_ids').

• max_resultsinteger

  The maximum number of Space results to return in a single response. Values must be between 1 and 100, inclusive.

• user__fieldsstring[]

  Specifies fields for expanded User objects (e.g., 'username', 'public_metrics'). Omitting this returns a default set of User fields.

• space__fieldsstring[]

  Specifies fields to include for each Space object (e.g., 'id', 'title'). Omitting this returns a default set of fields.

• topic__fieldsstring[]

  Specifies fields for expanded Topic objects (e.g., 'id', 'name'). Omitting this returns a default set of Topic fields.

Parámetros de salida

• dataobjectObligatorio

  The main response object containing a list of matching Spaces, any included expansions (like User or Topic objects), and metadata about the results.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  Text content of the Direct Message. At least one of `text` or `attachments` is required.

• attachmentsobject[]

  A list of media attachments for the Direct Message, each specifying a `media_id`. At least one of `text` or `attachments` is required.

• dm_conversation_idstringObligatorio

  Identifier of the DM conversation; can be a numeric string (group DM) or two user IDs hyphen-separated (one-on-one DM).

Parámetros de salida

• dataobjectObligatorio

  Contains the data for the successfully sent message event or errors if the request failed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  Text content of the Direct Message.

• attachmentsobject[]

  Media attachments for the Direct Message.

• participant_idstringObligatorio

  User ID of the recipient.

Parámetros de salida

• dataobjectObligatorio

  The API response payload.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the Twitter Space to retrieve.

• expansionsstring[]

  Objects to expand in the response (e.g., `creator_id`). Customize with corresponding `*_fields`. See ExpansionsEnm0 for options.

• user__fieldsstring[]

  Fields for User objects expanded via `expansions` (e.g., if `creator_id` is expanded). See UserFieldsEnm0 for options.

• space__fieldsstring[]

  Fields to include for the Space object; defaults to a standard set if omitted. See SpaceFieldsEnm0 for options.

• topic__fieldsstring[]

  Fields for Topic objects expanded via `expansions` (e.g., if `topic_ids` is expanded). See TopicFieldsEnm0 for options.

Parámetros de salida

• dataobjectObligatorio

  The full response from the Twitter API, including the Space data, any errors, and requested expansions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idsstring[]Obligatorio

  A list of User IDs whose Spaces will be retrieved. At least one User ID must be provided.

• expansionsstring[]

  Specifies which related objects to expand for more detailed information in the response.

• user__fieldsstring[]

  Specifies which fields to return for User objects, applicable when User-related IDs (e.g., 'creator_id') are included in 'expansions'.

• space__fieldsstring[]

  Specifies which fields to return for each Space object.

• topic__fieldsstring[]

  Specifies which fields to return for Topic objects, applicable when 'topic_ids' is included in 'expansions'.

Parámetros de salida

• dataobjectObligatorio

  The full response payload containing Spaces, included objects, errors, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]Obligatorio

  Unique identifiers for the Twitter Spaces to retrieve.

• expansionsstring[]

  Objects to expand and include their full details (e.g., 'creator_id', 'host_ids'). See `ExpansionsEnm0` for options.

• user__fieldsstring[]

  Specific fields for User objects included via expansions (e.g., if 'creator_id' is in 'expansions'). See `UserFieldsEnm0` for options.

• space__fieldsstring[]

  Specific fields to return for each Space object; omits to return default fields. See `SpaceFieldsEnm0` for options.

• topic__fieldsstring[]

  Specific fields for Topic objects included via expansions (e.g., if 'topic_ids' is in 'expansions'). See `TopicFieldsEnm0` for options.

Parámetros de salida

• dataobjectObligatorio

  Core response: `data` holds Space objects, `includes` holds expansions, `errors` lists issues.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the user who is unfollowing the list.

• list_idstringObligatorio

  The ID of the Twitter List to be unfollowed.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the Twitter API. Contains either the `data` payload with the unfollow status or an `errors` object detailing issues encountered.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• source_user_idstringObligatorio

  The user ID of the authenticated user initiating the unfollow action.

• target_user_idstringObligatorio

  The user ID of the user that the `source_user_id` intends to unfollow.

Parámetros de salida

• dataobjectObligatorio

  The API response, containing success data or error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the authenticated user who is unliking the post. This user ID must match the user context of the authentication token.

• tweet_idstringObligatorio

  The ID of the post (Tweet) that the user is requesting to unlike.

Parámetros de salida

• dataobjectObligatorio

  The response payload which includes the outcome of the unlike action or any errors encountered.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• source_user_idstringObligatorio

  User ID of the authenticated user performing the unmute.

• target_user_idstringObligatorio

  User ID of the user to be unmuted.

Parámetros de salida

• dataobjectObligatorio

  Main response content, including success data or error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  User ID of the account whose currently pinned List is to be unpinned.

• list_idstringObligatorio

  ID of the List to unpin from the user's profile.

Parámetros de salida

• dataobjectObligatorio

  Indicates the outcome of the unpin operation or any encountered errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The user ID of the account whose retweet is being removed.

• source_tweet_idstringObligatorio

  The unique identifier of the Post (Tweet) that the user is requesting to unretweet.

Parámetros de salida

• dataobjectObligatorio

  Contains data confirming the unretweet status or a list of errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter List to be updated.

• namestring

  New name for the List; must be a non-empty string if provided.

• privateboolean

  Controls the visibility of the List: `True` for private, `False` for public.

• descriptionstring

  New description for the List; an empty string clears the existing description.

Parámetros de salida

• dataobjectObligatorio

  API response; successful requests include `data.updated: true`, failures populate `errors`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Twitter user.

• excludestring[]

  Tweet types to exclude from results (e.g., 'replies', 'retweets').

• end_timestring

  Latest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) for Tweets. Overridden by `until_id`.

• since_idstring

  Returns results with a Tweet ID more recent than the specified ID. Takes precedence over `start_time`.

• until_idstring

  Returns results with a Tweet ID older than the specified ID. Takes precedence over `end_time`.

• expansionsstring[]

  Objects to expand and include in the response for detailed information.

• start_timestring

  Earliest UTC timestamp (YYYY-MM-DDTHH:mm:ssZ) for Tweets. Overridden by `since_id`.

• max_resultsinteger

  Maximum number of Tweets per page (5-100). API default is typically 100.

• poll__fieldsstring[]

  Specific Poll fields for poll objects, if `expansions` includes `attachments.poll_ids`.

• user__fieldsstring[]

  Specific User fields for user objects, if `expansions` includes user-related items like `author_id`.

• media__fieldsstring[]

  Specific Media fields for media objects, if `expansions` includes `attachments.media_keys`.

• place__fieldsstring[]

  Specific Place fields for place objects, if `expansions` includes `geo.place_id`.

• tweet__fieldsstring[]

  Specific Tweet fields to include in the response.

• pagination_tokenstring

  Token from a previous response to fetch the next page of results.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, including the list of Tweets, any errors, included objects, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The user ID of the authenticated user who is liking the Tweet.

• tweet_idstringObligatorio

  The unique identifier of the Tweet to be liked.

Parámetros de salida

• dataobjectObligatorio

  The structured response data, including the like status or any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier (ID) of an existing Twitter user.

• expansionsstring[]

  Linked entities to expand (e.g., `pinned_tweet_id` for the full pinned Tweet). See `ExpansionsEnm0` for options.

• user__fieldsstring[]

  Specifies which user attributes to return. See `UserFieldsEnm0` for options.

• tweet__fieldsstring[]

  Specifies which tweet attributes to return for expanded tweets. See `TweetFieldsEnm0` for options.

Parámetros de salida

• dataobjectObligatorio

  Contains the full response data from the Twitter API, including the user object, any included expansions, and errors if they occurred.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]Obligatorio

  User IDs to retrieve (up to 100 per request).

• expansionsstring[]

  Objects to expand in the response (e.g., 'pinned_tweet_id'). See ExpansionsEnm0 for options.

• user__fieldsstring[]

  Specific user fields to return. See UserFieldsEnm0 for options.

• tweet__fieldsstring[]

  Tweet fields to return for expanded tweet objects. See TweetFieldsEnm0 for options.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, containing a list of user objects (Datum) and any included expansions (like Tweets, Places, etc.).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  Twitter username (handle) to look up, without the '@' symbol.

• expansionsstring[]

  Fields to expand for more detailed information on objects like `pinned_tweet_id` (includes full Tweet object).

• user__fieldsstring[]

  User fields to include in the response for additional user information.

• tweet__fieldsstring[]

  Tweet fields to include for Tweets returned via expansions (e.g., `pinned_tweet_id`).

Parámetros de salida

• dataobjectObligatorio

  Main response with requested user data, included expansions, and errors if any.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamesstring[]Obligatorio

  A list of Twitter screen names (handles) for the users to look up. A maximum of 100 usernames can be specified.

• expansionsstring[]

  A list of objects to expand in the response, providing more detailed information. For example, 'pinned_tweet_id' will include the full Tweet object for a user's pinned Tweet.

• user__fieldsstring[]

  A list of user fields to include in the response. These fields provide additional information about the users being looked up.

• tweet__fieldsstring[]

  A list of tweet fields to include in the response if 'expansions' includes 'pinned_tweet_id'. These fields provide additional information about the pinned tweet.

Parámetros de salida

• dataobjectObligatorio

  The API response containing user data, included objects, and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• expansionsstring[]

  A comma-separated list of fields to expand for related entities (e.g., pinned tweet, affiliated user).

• user__fieldsstring[]

  A comma-separated list of user-specific information to include in the response.

• tweet__fieldsstring[]

  A comma-separated list of tweet-specific information for expanded tweets (e.g., if 'pinned_tweet_id' is in expansions).

Parámetros de salida

• dataobjectObligatorio

  The full response payload containing the user data, any included expansions, and errors if applicable.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not