Can I use Twitter / X as a CLI?

Yes. KosmoKrator exposes a Twitter / X CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Twitter / X through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Twitter / X tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Twitter / X credentials stored?

Twitter / X credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Twitter / X MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Twitter / X Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Twitter / X KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.x.*. Use lua_read_doc("integrations.x") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Twitter / X workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.x.get_account_activity_subscription_count({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("x"))' --json
kosmo integrations:lua --eval 'print(docs.read("x.get_account_activity_subscription_count"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local x = app.integrations.x
local result = x.get_account_activity_subscription_count({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.x, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.x.default.* or app.integrations.x.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Twitter / X, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Twitter / X — Lua API Reference

This integration is generated from the official X OpenAPI document version 2.162 and exposes 162 X API operations.

Authentication

Configure one or more credential modes:

bearer_token for app-only public reads.
access_token for OAuth 2.0 user-context operations.
api_key, api_secret, access_token, and access_token_secret for OAuth 1.0a user-context operations.

Each tool carries auth_modes, required_scopes, and runtime_mode metadata in the generated catalog.

Runtime Notes

Tools marked stream require a host streaming runner.
Tools marked webhook_subscription require a public callback endpoint.
Enterprise or approved-access endpoints return clear API errors if the configured X account lacks access.

Examples

local me = app.integrations.x.x_get_users_me({})
local user = app.integrations.x.x_get_users_by_username({ username = "XDevelopers" })

For multi-account hosts:

app.integrations.x.default.x_find_my_user({})
app.integrations.x.work.x_find_my_user({})

Raw agent markdown

# Twitter / X — Lua API Reference

This integration is generated from the official X OpenAPI document version `2.162` and exposes 162 X API operations.

## Authentication

Configure one or more credential modes:

- `bearer_token` for app-only public reads.
- `access_token` for OAuth 2.0 user-context operations.
- `api_key`, `api_secret`, `access_token`, and `access_token_secret` for OAuth 1.0a user-context operations.

Each tool carries `auth_modes`, `required_scopes`, and `runtime_mode` metadata in the generated catalog.

## Runtime Notes

- Tools marked `stream` require a host streaming runner.
- Tools marked `webhook_subscription` require a public callback endpoint.
- Enterprise or approved-access endpoints return clear API errors if the configured X account lacks access.

## Examples

```lua
local me = app.integrations.x.x_get_users_me({})
local user = app.integrations.x.x_get_users_by_username({ username = "XDevelopers" })
```

For multi-account hosts:

```lua
app.integrations.x.default.x_find_my_user({})
app.integrations.x.work.x_find_my_user({})
```

Metadata-derived Lua example

local result = app.integrations.x.get_account_activity_subscription_count({})
print(result)

Functions

get_account_activity_subscription_count Read

Get subscription count

Lua path: app.integrations.x.get_account_activity_subscription_count
Full name: x.x_get_account_activity_subscription_count

Parameter	Type	Required	Description
No parameters.

validate_account_activity_subscription Read

Validate subscription

Lua path: app.integrations.x.validate_account_activity_subscription
Full name: x.x_validate_account_activity_subscription

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to check subscription against.

create_account_activity_subscription Write

Create subscription

Lua path: app.integrations.x.create_account_activity_subscription
Full name: x.x_create_account_activity_subscription

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to check subscription against.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_account_activity_subscriptions Read

Get subscriptions

Lua path: app.integrations.x.get_account_activity_subscriptions
Full name: x.x_get_account_activity_subscriptions

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to pull subscriptions for.

delete_account_activity_subscription Write

Delete subscription

Lua path: app.integrations.x.delete_account_activity_subscription
Full name: x.x_delete_account_activity_subscription

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to check subscription against.
`user_id`	string	yes	User ID to unsubscribe from.

activity_stream Read

Activity Stream

Lua path: app.integrations.x.activity_stream
Full name: x.x_activity_stream

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided.

delete_activity_subscriptions_by_ids Write

Delete X activity subscriptions by IDs

Lua path: app.integrations.x.delete_activity_subscriptions_by_ids
Full name: x.x_delete_activity_subscriptions_by_ids

Parameter	Type	Required	Description
`ids`	array	yes	Comma-separated list of subscription IDs to delete.

get_activity_subscriptions Read

Get X activity subscriptions

Lua path: app.integrations.x.get_activity_subscriptions
Full name: x.x_get_activity_subscriptions

Parameter	Type	Required	Description
`max_results`	integer	no	The maximum number of results to return per page.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.

create_activity_subscription Write

Create X activity subscription

Lua path: app.integrations.x.create_activity_subscription
Full name: x.x_create_activity_subscription

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

delete_activity_subscription Write

Deletes X activity subscription

Lua path: app.integrations.x.delete_activity_subscription
Full name: x.x_delete_activity_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	The ID of the subscription to delete.

update_activity_subscription Write

Update X activity subscription

Lua path: app.integrations.x.update_activity_subscription
Full name: x.x_update_activity_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	The ID of the subscription to update.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_chat_conversations Read

Get Chat Conversations

Lua path: app.integrations.x.get_chat_conversations
Full name: x.x_get_chat_conversations

Parameter	Type	Required	Description
`max_results`	integer	no	Maximum number of conversations to return.
`pagination_token`	string	no	Token for pagination to retrieve the next page of results.
`chat_conversation.fields`	array	no	A comma separated list of ChatConversation fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

create_chat_conversation Write

Create Chat Group Conversation

Lua path: app.integrations.x.create_chat_conversation
Full name: x.x_create_chat_conversation

Parameter	Type	Required	Description
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

initialize_chat_group Write

Initialize Chat Group

Lua path: app.integrations.x.initialize_chat_group
Full name: x.x_initialize_chat_group

Parameter	Type	Required	Description
No parameters.

get_chat_conversation Read

Get Chat Conversation

Lua path: app.integrations.x.get_chat_conversation
Full name: x.x_get_chat_conversation

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').
`max_results`	integer	no	Maximum number of message events to return.
`pagination_token`	string	no	Token for pagination to retrieve the next page of results.
`chat_message_event.fields`	array	no	A comma separated list of ChatMessageEvent fields to display.

initialize_chat_conversation_keys Write

Initialize Conversation Keys

Lua path: app.integrations.x.initialize_chat_conversation_keys
Full name: x.x_initialize_chat_conversation_keys

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

add_chat_group_members Write

Add members to a Chat group conversation

Lua path: app.integrations.x.add_chat_group_members
Full name: x.x_add_chat_group_members

Parameter	Type	Required	Description
`id`	string	yes	The Chat group conversation ID.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

send_chat_message Write

Send Chat Message

Lua path: app.integrations.x.send_chat_message
Full name: x.x_send_chat_message

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

mark_chat_conversation_read Write

Mark Conversation as Read

Lua path: app.integrations.x.mark_chat_conversation_read
Full name: x.x_mark_chat_conversation_read

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

send_chat_typing_indicator Write

Send Typing Indicator

Lua path: app.integrations.x.send_chat_typing_indicator
Full name: x.x_send_chat_typing_indicator

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').

chat_media_upload_initialize Write

Initialize Chat Media Upload

Lua path: app.integrations.x.chat_media_upload_initialize
Full name: x.x_chat_media_upload_initialize

Parameter	Type	Required	Description
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

chat_media_upload_append Write

Append Chat Media Upload

Lua path: app.integrations.x.chat_media_upload_append
Full name: x.x_chat_media_upload_append

Parameter	Type	Required	Description
`id`	string	yes	The session/resume id from initialize.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

chat_media_upload_finalize Write

Finalize Chat Media Upload

Lua path: app.integrations.x.chat_media_upload_finalize
Full name: x.x_chat_media_upload_finalize

Parameter	Type	Required	Description
`id`	string	yes	The session/resume id from initialize.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

chat_media_download Read

Download Chat Media

Lua path: app.integrations.x.chat_media_download
Full name: x.x_chat_media_download

Parameter	Type	Required	Description
`id`	string	yes	The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').
`media_hash_key`	string	yes	The media hash key returned from the upload initialize step.

search_communities Read

Search Communities

Lua path: app.integrations.x.search_communities
Full name: x.x_search_communities

Parameter	Type	Required	Description
`query`	string	yes	Query to search communities.
`max_results`	integer	no	The maximum number of search results to be returned by a request.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`community.fields`	array	no	A comma separated list of Community fields to display.

get_communities_by_id Read

Get Community by ID

Lua path: app.integrations.x.get_communities_by_id
Full name: x.x_get_communities_by_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Community.
`community.fields`	array	no	A comma separated list of Community fields to display.

get_compliance_jobs Read

Get Compliance Jobs

Lua path: app.integrations.x.get_compliance_jobs
Full name: x.x_get_compliance_jobs

Parameter	Type	Required	Description
`type`	string	yes	Type of Compliance Job to list.
`status`	string	no	Status of Compliance Job to list.
`compliance_job.fields`	array	no	A comma separated list of ComplianceJob fields to display.

create_compliance_jobs Write

Create Compliance Job

Lua path: app.integrations.x.create_compliance_jobs
Full name: x.x_create_compliance_jobs

Parameter	Type	Required	Description
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

get_compliance_jobs_by_id Read

Get Compliance Job by ID

Lua path: app.integrations.x.get_compliance_jobs_by_id
Full name: x.x_get_compliance_jobs_by_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Compliance Job to retrieve.
`compliance_job.fields`	array	no	A comma separated list of ComplianceJob fields to display.

delete_connections_by_uuids Write

Terminate multiple connections

Lua path: app.integrations.x.delete_connections_by_uuids
Full name: x.x_delete_connections_by_uuids

Parameter	Type	Required	Description
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

get_connection_history Read

Get Connection History

Lua path: app.integrations.x.get_connection_history
Full name: x.x_get_connection_history

Parameter	Type	Required	Description
`status`	string	no	Filter by connection status. Use 'active' for current connections, 'inactive' for historical/disconnected connections, or 'all' for both.
`endpoints`	array	no	Filter by streaming endpoint. Specify one or more endpoint names to filter results.
`max_results`	integer	no	The maximum number of results to return per page.
`pagination_token`	string	no	Token for paginating through results. Use the value from 'next_token' in the previous response.
`connection.fields`	array	no	A comma separated list of Connection fields to display.

delete_all_connections Write

Terminate all connections

Lua path: app.integrations.x.delete_all_connections
Full name: x.x_delete_all_connections

Parameter	Type	Required	Description
No parameters.

delete_connections_by_endpoint Write

Terminate connections by endpoint

Lua path: app.integrations.x.delete_connections_by_endpoint
Full name: x.x_delete_connections_by_endpoint

Parameter	Type	Required	Description
`endpoint_id`	string	yes	The endpoint ID to terminate connections for.

create_direct_messages_conversation Write

Create DM conversation

Lua path: app.integrations.x.create_direct_messages_conversation
Full name: x.x_create_direct_messages_conversation

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

dm_conversations_media_download Read

Download DM Media

Lua path: app.integrations.x.dm_conversations_media_download
Full name: x.x_dm_conversations_media_download

Parameter	Type	Required	Description
`dm_id`	string	yes	The unique identifier of the Direct Message event containing the media.
`media_id`	string	yes	The unique identifier of the media attached to the Direct Message.
`resource_id`	string	yes	The resource identifier of the media file, including file extension (e.g. 'hVJQTwig.jpg').

get_direct_messages_events_by_participant_id Read

Get DM events for a DM conversation

Lua path: app.integrations.x.get_direct_messages_events_by_participant_id
Full name: x.x_get_direct_messages_events_by_participant_id

Parameter	Type	Required	Description
`participant_id`	string	yes	The ID of the participant user for the One to One DM conversation.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`event_types`	array	no	The set of event_types to include in the results.
`dm_event.fields`	array	no	A comma separated list of DmEvent fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

create_direct_messages_by_participant_id Write

Create DM message by participant ID

Lua path: app.integrations.x.create_direct_messages_by_participant_id
Full name: x.x_create_direct_messages_by_participant_id

Parameter	Type	Required	Description
`participant_id`	string	yes	The ID of the recipient user that will receive the DM.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

create_direct_messages_by_conversation_id Write

Create DM message by conversation ID

Lua path: app.integrations.x.create_direct_messages_by_conversation_id
Full name: x.x_create_direct_messages_by_conversation_id

Parameter	Type	Required	Description
`dm_conversation_id`	string	yes	The DM Conversation ID.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_direct_messages_events_by_conversation_id Read

Get DM events for a DM conversation

Lua path: app.integrations.x.get_direct_messages_events_by_conversation_id
Full name: x.x_get_direct_messages_events_by_conversation_id

Parameter	Type	Required	Description
`id`	string	yes	The DM conversation ID.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`event_types`	array	no	The set of event_types to include in the results.
`dm_event.fields`	array	no	A comma separated list of DmEvent fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_direct_messages_events Read

Get DM events

Lua path: app.integrations.x.get_direct_messages_events
Full name: x.x_get_direct_messages_events

Parameter	Type	Required	Description
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`event_types`	array	no	The set of event_types to include in the results.
`dm_event.fields`	array	no	A comma separated list of DmEvent fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

delete_direct_messages_events Write

Delete DM event

Lua path: app.integrations.x.delete_direct_messages_events
Full name: x.x_delete_direct_messages_events

Parameter	Type	Required	Description
`event_id`	string	yes	The ID of the direct-message event to delete.

get_direct_messages_events_by_id Read

Get DM event by ID

Lua path: app.integrations.x.get_direct_messages_events_by_id
Full name: x.x_get_direct_messages_events_by_id

Parameter	Type	Required	Description
`event_id`	string	yes	dm event id.
`dm_event.fields`	array	no	A comma separated list of DmEvent fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

evaluate_community_notes Write

Evaluate a Community Note

Lua path: app.integrations.x.evaluate_community_notes
Full name: x.x_evaluate_community_notes

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_insights28_hr Read

Get 28-hour Post insights

Lua path: app.integrations.x.get_insights28_hr
Full name: x.x_get_insights28_hr

Parameter	Type	Required	Description
`tweet_ids`	array	yes	List of PostIds for 28hr metrics.
`granularity`	string	yes	granularity of metrics response.
`requested_metrics`	array	yes	request metrics for historical request.
`engagement.fields`	array	no	A comma separated list of Engagement fields to display.

get_insights_historical Read

Get historical Post insights

Lua path: app.integrations.x.get_insights_historical
Full name: x.x_get_insights_historical

Parameter	Type	Required	Description
`tweet_ids`	array	yes	List of PostIds for historical metrics.
`end_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
`start_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
`granularity`	string	yes	granularity of metrics response.
`requested_metrics`	array	yes	request metrics for historical request.
`engagement.fields`	array	no	A comma separated list of Engagement fields to display.

stream_likes_compliance Read

Stream Likes compliance data

Lua path: app.integrations.x.stream_likes_compliance
Full name: x.x_stream_likes_compliance

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided.

stream_likes_firehose Read

Stream all Likes

Lua path: app.integrations.x.stream_likes_firehose
Full name: x.x_stream_likes_firehose

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`like_with_tweet_author.fields`	array	no	A comma separated list of LikeWithTweetAuthor fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

stream_likes_sample10 Read

Stream sampled Likes

Lua path: app.integrations.x.stream_likes_sample10
Full name: x.x_stream_likes_sample10

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`like_with_tweet_author.fields`	array	no	A comma separated list of LikeWithTweetAuthor fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

create_lists Write

Create List

Lua path: app.integrations.x.create_lists
Full name: x.x_create_lists

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

delete_lists Write

Delete List

Lua path: app.integrations.x.delete_lists
Full name: x.x_delete_lists

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List to delete.

get_lists_by_id Read

Get List by ID

Lua path: app.integrations.x.get_lists_by_id
Full name: x.x_get_lists_by_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List.
`list.fields`	array	no	A comma separated list of List fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

update_lists Write

Update List

Lua path: app.integrations.x.update_lists
Full name: x.x_update_lists

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List to modify.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_lists_followers Read

Get List followers

Lua path: app.integrations.x.get_lists_followers
Full name: x.x_get_lists_followers

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_lists_members Read

Get List members

Lua path: app.integrations.x.get_lists_members
Full name: x.x_get_lists_members

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

add_lists_member Write

Add List member

Lua path: app.integrations.x.add_lists_member
Full name: x.x_add_lists_member

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List for which to add a member.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

remove_lists_member_by_user_id Write

Remove List member

Lua path: app.integrations.x.remove_lists_member_by_user_id
Full name: x.x_remove_lists_member_by_user_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List to remove a member.
`user_id`	string	yes	The ID of User that will be removed from the List.

get_lists_posts Read

Get List Posts

Lua path: app.integrations.x.get_lists_posts
Full name: x.x_get_lists_posts

Parameter	Type	Required	Description
`id`	string	yes	The ID of the List.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_media_by_media_keys Read

Get Media by media keys

Lua path: app.integrations.x.get_media_by_media_keys
Full name: x.x_get_media_by_media_keys

Parameter	Type	Required	Description
`media_keys`	array	yes	A comma separated list of Media Keys. Up to 100 are allowed in a single request.
`media.fields`	array	no	A comma separated list of Media fields to display.

get_media_analytics Read

Get Media analytics

Lua path: app.integrations.x.get_media_analytics
Full name: x.x_get_media_analytics

Parameter	Type	Required	Description
`media_keys`	array	yes	A comma separated list of Media Keys. Up to 100 are allowed in a single request.
`end_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
`start_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
`granularity`	string	yes	The granularity for the search counts results.
`media_analytics.fields`	array	no	A comma separated list of MediaAnalytics fields to display.

create_media_metadata Write

Create Media metadata

Lua path: app.integrations.x.create_media_metadata
Full name: x.x_create_media_metadata

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

delete_media_subtitles Write

Delete Media subtitles

Lua path: app.integrations.x.delete_media_subtitles
Full name: x.x_delete_media_subtitles

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

create_media_subtitles Write

Create Media subtitles

Lua path: app.integrations.x.create_media_subtitles
Full name: x.x_create_media_subtitles

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_media_upload_status Read

Get Media upload status

Lua path: app.integrations.x.get_media_upload_status
Full name: x.x_get_media_upload_status

Parameter	Type	Required	Description
`media_id`	string	yes	Media id for the requested media upload status.
`command`	string	no	The command for the media upload request.

media_upload Write

Upload media

Lua path: app.integrations.x.media_upload
Full name: x.x_media_upload

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

initialize_media_upload Write

Initialize media upload

Lua path: app.integrations.x.initialize_media_upload
Full name: x.x_initialize_media_upload

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

append_media_upload Write

Append Media upload

Lua path: app.integrations.x.append_media_upload
Full name: x.x_append_media_upload

Parameter	Type	Required	Description
`id`	string	yes	The media identifier for the media to perform the append operation.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

finalize_media_upload Write

Finalize Media upload

Lua path: app.integrations.x.finalize_media_upload
Full name: x.x_finalize_media_upload

Parameter	Type	Required	Description
`id`	string	yes	The media id of the targeted media to finalize.

get_media_by_media_key Read

Get Media by media key

Lua path: app.integrations.x.get_media_by_media_key
Full name: x.x_get_media_by_media_key

Parameter	Type	Required	Description
`media_key`	string	yes	A single Media Key.
`media.fields`	array	no	A comma separated list of Media fields to display.

search_news Read

Search News

Lua path: app.integrations.x.search_news
Full name: x.x_search_news

Parameter	Type	Required	Description
`query`	string	yes	The search query.
`max_results`	integer	no	The number of results to return.
`max_age_hours`	integer	no	The maximum age of the News story to search for.
`news.fields`	array	no	A comma separated list of News fields to display.

get_news Read

Get news stories by ID

Lua path: app.integrations.x.get_news
Full name: x.x_get_news

Parameter	Type	Required	Description
`id`	string	yes	The ID of the news story.
`news.fields`	array	no	A comma separated list of News fields to display.

create_community_notes Write

Create a Community Note

Lua path: app.integrations.x.create_community_notes
Full name: x.x_create_community_notes

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

search_community_notes_written Read

Search for Community Notes Written

Lua path: app.integrations.x.search_community_notes_written
Full name: x.x_search_community_notes_written

Parameter	Type	Required	Description
`test_mode`	boolean	yes	If true, return the notes the caller wrote for the test. If false, return the notes the caller wrote on the product.
`pagination_token`	string	no	Pagination token to get next set of posts eligible for notes.
`max_results`	integer	no	Max results to return.
`note.fields`	array	no	A comma separated list of Note fields to display.

search_eligible_posts Read

Search for Posts Eligible for Community Notes

Lua path: app.integrations.x.search_eligible_posts
Full name: x.x_search_eligible_posts

Parameter	Type	Required	Description
`test_mode`	boolean	yes	If true, return a list of posts that are for the test. If false, return a list of posts that the bots can write proposed notes on the product.
`pagination_token`	string	no	Pagination token to get next set of posts eligible for notes.
`max_results`	integer	no	Max results to return.
`post_selection`	string	no	The selection of posts to return. Valid values are 'feed_size: [small\|large\|xl\|xxl], feed_lang: [en\|es\|...\|all]'. Default (if not specified) is 'feed_size: small, feed_lang: en'. Only top AI writers have access to large, xl, and xxl size feeds.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

delete_community_notes Write

Delete a Community Note

Lua path: app.integrations.x.delete_community_notes
Full name: x.x_delete_community_notes

Parameter	Type	Required	Description
`id`	string	yes	The community note id to delete.

get_open_api_spec Read

Get OpenAPI Spec.

Lua path: app.integrations.x.get_open_api_spec
Full name: x.x_get_open_api_spec

Parameter	Type	Required	Description
No parameters.

get_spaces_by_ids Read

Get Spaces by IDs

Lua path: app.integrations.x.get_spaces_by_ids
Full name: x.x_get_spaces_by_ids

Parameter	Type	Required	Description
`ids`	array	yes	The list of Space IDs to return.
`space.fields`	array	no	A comma separated list of Space fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.
`topic.fields`	array	no	A comma separated list of Topic fields to display.

get_spaces_by_creator_ids Read

Get Spaces by creator IDs

Lua path: app.integrations.x.get_spaces_by_creator_ids
Full name: x.x_get_spaces_by_creator_ids

Parameter	Type	Required	Description
`user_ids`	array	yes	The IDs of Users to search through.
`space.fields`	array	no	A comma separated list of Space fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.
`topic.fields`	array	no	A comma separated list of Topic fields to display.

search_spaces Read

Search Spaces

Lua path: app.integrations.x.search_spaces
Full name: x.x_search_spaces

Parameter	Type	Required	Description
`query`	string	yes	The search query.
`state`	string	no	The state of Spaces to search for.
`max_results`	integer	no	The number of results to return.
`space.fields`	array	no	A comma separated list of Space fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.
`topic.fields`	array	no	A comma separated list of Topic fields to display.

get_spaces_by_id Read

Get space by ID

Lua path: app.integrations.x.get_spaces_by_id
Full name: x.x_get_spaces_by_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Space to be retrieved.
`space.fields`	array	no	A comma separated list of Space fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.
`topic.fields`	array	no	A comma separated list of Topic fields to display.

get_spaces_buyers Read

Get Space ticket buyers

Lua path: app.integrations.x.get_spaces_buyers
Full name: x.x_get_spaces_buyers

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Space to be retrieved.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`max_results`	integer	no	The maximum number of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_spaces_posts Read

Get Space Posts

Lua path: app.integrations.x.get_spaces_posts
Full name: x.x_get_spaces_posts

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Space to be retrieved.
`max_results`	integer	no	The number of Posts to fetch from the provided space. If not provided, the value will default to the maximum of 100.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_trends_by_woeid Read

Get Trends by WOEID

Lua path: app.integrations.x.get_trends_by_woeid
Full name: x.x_get_trends_by_woeid

Parameter	Type	Required	Description
`woeid`	integer	yes	The WOEID of the place to lookup a trend for.
`max_trends`	integer	no	The maximum number of results.
`trend.fields`	array	no	A comma separated list of Trend fields to display.

get_posts_by_ids Read

Get Posts by IDs

Lua path: app.integrations.x.get_posts_by_ids
Full name: x.x_get_posts_by_ids

Parameter	Type	Required	Description
`ids`	array	yes	A comma separated list of Post IDs. Up to 100 are allowed in a single request.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

create_posts Write

Create or Edit Post

Lua path: app.integrations.x.create_posts
Full name: x.x_create_posts

Parameter	Type	Required	Description
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

get_posts_analytics Read

Get Post analytics

Lua path: app.integrations.x.get_posts_analytics
Full name: x.x_get_posts_analytics

Parameter	Type	Required	Description
`ids`	array	yes	A comma separated list of Post IDs. Up to 100 are allowed in a single request.
`end_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
`start_time`	string	yes	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
`granularity`	string	yes	The granularity for the search counts results.
`analytics.fields`	array	no	A comma separated list of Analytics fields to display.

stream_posts_compliance Read

Stream Posts compliance data

Lua path: app.integrations.x.stream_posts_compliance
Full name: x.x_stream_posts_compliance

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided.

get_posts_counts_all Read

Get count of all Posts

Lua path: app.integrations.x.get_posts_counts_all
Full name: x.x_get_posts_counts_all

Parameter	Type	Required	Description
`query`	string	yes	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
`since_id`	string	no	Returns results with a Post ID greater than (that is, more recent than) the specified ID.
`until_id`	string	no	Returns results with a Post ID less than (that is, older than) the specified ID.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`granularity`	string	no	The granularity for the search counts results.
`search_count.fields`	array	no	A comma separated list of SearchCount fields to display.

get_posts_counts_recent Read

Get count of recent Posts

Lua path: app.integrations.x.get_posts_counts_recent
Full name: x.x_get_posts_counts_recent

Parameter	Type	Required	Description
`query`	string	yes	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
`since_id`	string	no	Returns results with a Post ID greater than (that is, more recent than) the specified ID.
`until_id`	string	no	Returns results with a Post ID less than (that is, older than) the specified ID.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`granularity`	string	no	The granularity for the search counts results.
`search_count.fields`	array	no	A comma separated list of SearchCount fields to display.

stream_posts_firehose Read

Stream all Posts

Lua path: app.integrations.x.stream_posts_firehose
Full name: x.x_stream_posts_firehose

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts_firehose_en Read

Stream English Posts

Lua path: app.integrations.x.stream_posts_firehose_en
Full name: x.x_stream_posts_firehose_en

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts_firehose_ja Read

Stream Japanese Posts

Lua path: app.integrations.x.stream_posts_firehose_ja
Full name: x.x_stream_posts_firehose_ja

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts_firehose_ko Read

Stream Korean Posts

Lua path: app.integrations.x.stream_posts_firehose_ko
Full name: x.x_stream_posts_firehose_ko

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts_firehose_pt Read

Stream Portuguese Posts

Lua path: app.integrations.x.stream_posts_firehose_pt
Full name: x.x_stream_posts_firehose_pt

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_labels_compliance Read

Stream Post labels

Lua path: app.integrations.x.stream_labels_compliance
Full name: x.x_stream_labels_compliance

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided.

stream_posts_sample Read

Stream sampled Posts

Lua path: app.integrations.x.stream_posts_sample
Full name: x.x_stream_posts_sample

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts_sample10 Read

Stream 10% sampled Posts

Lua path: app.integrations.x.stream_posts_sample10
Full name: x.x_stream_posts_sample10

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

search_posts_all Read

Search all Posts

Lua path: app.integrations.x.search_posts_all
Full name: x.x_search_posts_all

Parameter	Type	Required	Description
`query`	string	yes	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
`since_id`	string	no	Returns results with a Post ID greater than (that is, more recent than) the specified ID.
`until_id`	string	no	Returns results with a Post ID less than (that is, older than) the specified ID.
`max_results`	integer	no	The maximum number of search results to be returned by a request.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`sort_order`	string	no	This order in which to return results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

search_posts_recent Read

Search recent Posts

Lua path: app.integrations.x.search_posts_recent
Full name: x.x_search_posts_recent

Parameter	Type	Required	Description
`query`	string	yes	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
`since_id`	string	no	Returns results with a Post ID greater than (that is, more recent than) the specified ID.
`until_id`	string	no	Returns results with a Post ID less than (that is, older than) the specified ID.
`max_results`	integer	no	The maximum number of search results to be returned by a request.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`sort_order`	string	no	This order in which to return results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

stream_posts Read

Stream filtered Posts

Lua path: app.integrations.x.stream_posts
Full name: x.x_stream_posts

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_rules Read

Get stream rules

Lua path: app.integrations.x.get_rules
Full name: x.x_get_rules

Parameter	Type	Required	Description
`ids`	array	no	A comma-separated list of Rule IDs.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This value is populated by passing the 'next_token' returned in a request to paginate through results.

update_rules Write

Update stream rules

Lua path: app.integrations.x.update_rules
Full name: x.x_update_rules

Parameter	Type	Required	Description
`dry_run`	boolean	no	Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes.
`delete_all`	boolean	no	Delete All can be used to delete all of the rules associated this client app, it should be specified with no other parameters. Once deleted, rules cannot be recovered.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

get_rule_counts Read

Get stream rule counts

Lua path: app.integrations.x.get_rule_counts
Full name: x.x_get_rule_counts

Parameter	Type	Required	Description
`rules_count.fields`	array	no	A comma separated list of RulesCount fields to display.

get_webhooks_stream_links Read

Get stream links

Lua path: app.integrations.x.get_webhooks_stream_links
Full name: x.x_get_webhooks_stream_links

Parameter	Type	Required	Description
No parameters.

delete_webhooks_stream_link Write

Delete stream link

Lua path: app.integrations.x.delete_webhooks_stream_link
Full name: x.x_delete_webhooks_stream_link

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to link to your FilteredStream ruleset.

create_webhooks_stream_link Write

Create stream link

Lua path: app.integrations.x.create_webhooks_stream_link
Full name: x.x_create_webhooks_stream_link

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook ID to link to your FilteredStream ruleset.
`tweet.fields`	string	no	A comma separated list of Tweet fields to display.
`expansions`	string	no	A comma separated list of fields to expand.
`media.fields`	string	no	A comma separated list of Media fields to display.
`poll.fields`	string	no	A comma separated list of Poll fields to display.
`user.fields`	string	no	A comma separated list of User fields to display.
`place.fields`	string	no	A comma separated list of Place fields to display.

delete_posts Write

Delete Post

Lua path: app.integrations.x.delete_posts
Full name: x.x_delete_posts

Parameter	Type	Required	Description
`id`	string	yes	The ID of the Post to be deleted.

get_posts_by_id Read

Get Post by ID

Lua path: app.integrations.x.get_posts_by_id
Full name: x.x_get_posts_by_id

Parameter	Type	Required	Description
`id`	string	yes	A single Post ID.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_posts_liking_users Read

Get Liking Users

Lua path: app.integrations.x.get_posts_liking_users
Full name: x.x_get_posts_liking_users

Parameter	Type	Required	Description
`id`	string	yes	A single Post ID.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_posts_quoted_posts Read

Get Quoted Posts

Lua path: app.integrations.x.get_posts_quoted_posts
Full name: x.x_get_posts_quoted_posts

Parameter	Type	Required	Description
`id`	string	yes	A single Post ID.
`max_results`	integer	no	The maximum number of results to be returned.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`exclude`	array	no	The set of entities to exclude (e.g. 'replies' or 'retweets').
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_posts_reposted_by Read

Get Reposted by

Lua path: app.integrations.x.get_posts_reposted_by
Full name: x.x_get_posts_reposted_by

Parameter	Type	Required	Description
`id`	string	yes	A single Post ID.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_posts_reposts Read

Get Reposts

Lua path: app.integrations.x.get_posts_reposts
Full name: x.x_get_posts_reposts

Parameter	Type	Required	Description
`id`	string	yes	A single Post ID.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

hide_posts_reply Write

Hide reply

Lua path: app.integrations.x.hide_posts_reply
Full name: x.x_hide_posts_reply

Parameter	Type	Required	Description
`tweet_id`	string	yes	The ID of the reply that you want to hide or unhide.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_usage Read

Get usage

Lua path: app.integrations.x.get_usage
Full name: x.x_get_usage

Parameter	Type	Required	Description
`days`	integer	no	The number of days for which you need usage for.
`usage.fields`	array	no	A comma separated list of Usage fields to display.

get_users_by_ids Read

Get Users by IDs

Lua path: app.integrations.x.get_users_by_ids
Full name: x.x_get_users_by_ids

Parameter	Type	Required	Description
`ids`	array	yes	A list of User IDs, comma-separated. You can specify up to 100 IDs.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_by_usernames Read

Get Users by usernames

Lua path: app.integrations.x.get_users_by_usernames
Full name: x.x_get_users_by_usernames

Parameter	Type	Required	Description
`usernames`	array	yes	A list of usernames, comma-separated.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_by_username Read

Get User by username

Lua path: app.integrations.x.get_users_by_username
Full name: x.x_get_users_by_username

Parameter	Type	Required	Description
`username`	string	yes	A username.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

stream_users_compliance Read

Stream Users compliance data

Lua path: app.integrations.x.stream_users_compliance
Full name: x.x_stream_users_compliance

Parameter	Type	Required	Description
`backfill_minutes`	integer	no	The number of minutes of backfill requested.
`partition`	integer	yes	The partition number.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided.

get_users_me Read

Get my User

Lua path: app.integrations.x.get_users_me
Full name: x.x_get_users_me

Parameter	Type	Required	Description
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_trends_personalized_trends Read

Get personalized Trends

Lua path: app.integrations.x.get_trends_personalized_trends
Full name: x.x_get_trends_personalized_trends

Parameter	Type	Required	Description
`personalized_trend.fields`	array	no	A comma separated list of PersonalizedTrend fields to display.

get_users_public_keys Read

Get public keys for multiple users

Lua path: app.integrations.x.get_users_public_keys
Full name: x.x_get_users_public_keys

Parameter	Type	Required	Description
`ids`	array	yes	A list of User IDs, comma-separated. You can specify up to 100 IDs.
`public_key.fields`	array	no	A comma separated list of PublicKey fields to display.

get_users_reposts_me Read

Get Reposts of me

Lua path: app.integrations.x.get_users_reposts_me
Full name: x.x_get_users_reposts_of_me

Parameter	Type	Required	Description
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

search_users Read

Search Users

Lua path: app.integrations.x.search_users
Full name: x.x_search_users

Parameter	Type	Required	Description
`query`	string	yes	TThe the query string by which to query for users.
`max_results`	integer	no	The maximum number of results.
`next_token`	string	no	This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_by_id Read

Get User by ID

Lua path: app.integrations.x.get_users_by_id
Full name: x.x_get_users_by_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_affiliates Read

Get affiliates

Lua path: app.integrations.x.get_users_affiliates
Full name: x.x_get_users_affiliates

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_blocking Read

Get blocking

Lua path: app.integrations.x.get_users_blocking
Full name: x.x_get_users_blocking

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_bookmarks Read

Get Bookmarks

Lua path: app.integrations.x.get_users_bookmarks
Full name: x.x_get_users_bookmarks

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

create_users_bookmark Write

Create Bookmark

Lua path: app.integrations.x.create_users_bookmark
Full name: x.x_create_users_bookmark

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to add bookmarks.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

get_users_bookmark_folders Read

Get Bookmark folders

Lua path: app.integrations.x.get_users_bookmark_folders
Full name: x.x_get_users_bookmark_folders

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.

get_users_bookmarks_by_folder_id Read

Get Bookmarks by folder ID

Lua path: app.integrations.x.get_users_bookmarks_by_folder_id
Full name: x.x_get_users_bookmarks_by_folder_id

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`folder_id`	string	yes	The ID of the Bookmark Folder that the authenticated User is trying to fetch Posts for.

delete_users_bookmark Write

Delete Bookmark

Lua path: app.integrations.x.delete_users_bookmark
Full name: x.x_delete_users_bookmark

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User whose bookmark is to be removed.
`tweet_id`	string	yes	The ID of the Post that the source User is removing from bookmarks.

block_users_dms Write

Block DMs

Lua path: app.integrations.x.block_users_dms
Full name: x.x_block_users_dms

Parameter	Type	Required	Description
`id`	string	yes	The ID of the target User that the authenticated user requesting to block dms for.

unblock_users_dms Write

Unblock DMs

Lua path: app.integrations.x.unblock_users_dms
Full name: x.x_unblock_users_dms

Parameter	Type	Required	Description
`id`	string	yes	The ID of the target User that the authenticated user requesting to unblock dms for.

get_users_followed_lists Read

Get followed Lists

Lua path: app.integrations.x.get_users_followed_lists
Full name: x.x_get_users_followed_lists

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`list.fields`	array	no	A comma separated list of List fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

follow_list Write

Follow List

Lua path: app.integrations.x.follow_list
Full name: x.x_follow_list

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that will follow the List.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

unfollow_list Write

Unfollow List

Lua path: app.integrations.x.unfollow_list
Full name: x.x_unfollow_list

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that will unfollow the List.
`list_id`	string	yes	The ID of the List to unfollow.

get_users_followers Read

Get followers

Lua path: app.integrations.x.get_users_followers
Full name: x.x_get_users_followers

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

get_users_following Read

Get following

Lua path: app.integrations.x.get_users_following
Full name: x.x_get_users_following

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

follow_user Write

Follow User

Lua path: app.integrations.x.follow_user
Full name: x.x_follow_user

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to follow the target User.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_users_liked_posts Read

Get liked Posts

Lua path: app.integrations.x.get_users_liked_posts
Full name: x.x_get_users_liked_posts

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

like_post Write

Like Post

Lua path: app.integrations.x.like_post
Full name: x.x_like_post

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to like the Post.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

unlike_post Write

Unlike Post

Lua path: app.integrations.x.unlike_post
Full name: x.x_unlike_post

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to unlike the Post.
`tweet_id`	string	yes	The ID of the Post that the User is requesting to unlike.

get_users_list_memberships Read

Get List memberships

Lua path: app.integrations.x.get_users_list_memberships
Full name: x.x_get_users_list_memberships

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`list.fields`	array	no	A comma separated list of List fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

get_users_mentions Read

Get mentions

Lua path: app.integrations.x.get_users_mentions
Full name: x.x_get_users_mentions

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`since_id`	string	no	The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified.
`until_id`	string	no	The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_users_muting Read

Get muting

Lua path: app.integrations.x.get_users_muting
Full name: x.x_get_users_muting

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`user.fields`	array	no	A comma separated list of User fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.

mute_user Write

Mute User

Lua path: app.integrations.x.mute_user
Full name: x.x_mute_user

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to mute the target User.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

get_users_owned_lists Read

Get owned Lists

Lua path: app.integrations.x.get_users_owned_lists
Full name: x.x_get_users_owned_lists

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get a specified 'page' of results.
`list.fields`	array	no	A comma separated list of List fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

get_users_pinned_lists Read

Get pinned Lists

Lua path: app.integrations.x.get_users_pinned_lists
Full name: x.x_get_users_pinned_lists

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`list.fields`	array	no	A comma separated list of List fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`user.fields`	array	no	A comma separated list of User fields to display.

pin_list Write

Pin List

Lua path: app.integrations.x.pin_list
Full name: x.x_pin_list

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that will pin the List.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

unpin_list Write

Unpin List

Lua path: app.integrations.x.unpin_list
Full name: x.x_unpin_list

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User for whom to return results.
`list_id`	string	yes	The ID of the List to unpin.

get_users_public_key Read

Get user public keys

Lua path: app.integrations.x.get_users_public_key
Full name: x.x_get_users_public_key

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`public_key.fields`	array	no	A comma separated list of PublicKey fields to display.

add_user_public_key Write

Add public key

Lua path: app.integrations.x.add_user_public_key
Full name: x.x_add_user_public_key

Parameter	Type	Required	Description
`id`	string	yes	The ID of the requesting user.
`body`	object	yes	Request body for this X API operation. Use the shape documented by the official operation schema.

repost_post Write

Repost Post

Lua path: app.integrations.x.repost_post
Full name: x.x_repost_post

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to repost the Post.
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

unrepost_post Write

Unrepost Post

Lua path: app.integrations.x.unrepost_post
Full name: x.x_unrepost_post

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User that is requesting to repost the Post.
`source_tweet_id`	string	yes	The ID of the Post that the User is requesting to unretweet.

get_users_timeline Read

Get Timeline

Lua path: app.integrations.x.get_users_timeline
Full name: x.x_get_users_timeline

Parameter	Type	Required	Description
`id`	string	yes	The ID of the authenticated source User to list Reverse Chronological Timeline Posts of.
`since_id`	string	no	The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified.
`until_id`	string	no	The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`exclude`	array	no	The set of entities to exclude (e.g. 'replies' or 'retweets').
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

get_users_posts Read

Get Posts

Lua path: app.integrations.x.get_users_posts
Full name: x.x_get_users_posts

Parameter	Type	Required	Description
`id`	string	yes	The ID of the User to lookup.
`since_id`	string	no	The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified.
`until_id`	string	no	The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified.
`max_results`	integer	no	The maximum number of results.
`pagination_token`	string	no	This parameter is used to get the next 'page' of results.
`exclude`	array	no	The set of entities to exclude (e.g. 'replies' or 'retweets').
`start_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified.
`end_time`	string	no	YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified.
`tweet.fields`	array	no	A comma separated list of Tweet fields to display.
`expansions`	array	no	A comma separated list of fields to expand.
`media.fields`	array	no	A comma separated list of Media fields to display.
`poll.fields`	array	no	A comma separated list of Poll fields to display.
`user.fields`	array	no	A comma separated list of User fields to display.
`place.fields`	array	no	A comma separated list of Place fields to display.

unfollow_user Write

Unfollow User

Lua path: app.integrations.x.unfollow_user
Full name: x.x_unfollow_user

Parameter	Type	Required	Description
`source_user_id`	string	yes	The ID of the authenticated source User that is requesting to unfollow the target User.
`target_user_id`	string	yes	The ID of the User that the source User is requesting to unfollow.

unmute_user Write

Unmute User

Lua path: app.integrations.x.unmute_user
Full name: x.x_unmute_user

Parameter	Type	Required	Description
`source_user_id`	string	yes	The ID of the authenticated source User that is requesting to unmute the target User.
`target_user_id`	string	yes	The ID of the User that the source User is requesting to unmute.

get_webhooks Read

Get webhook

Lua path: app.integrations.x.get_webhooks
Full name: x.x_get_webhooks

Parameter	Type	Required	Description
`webhook_config.fields`	array	no	A comma separated list of WebhookConfig fields to display.

create_webhooks Write

Create webhook

Lua path: app.integrations.x.create_webhooks
Full name: x.x_create_webhooks

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

create_webhook_replay_job Write

Create replay job for webhook

Lua path: app.integrations.x.create_webhook_replay_job
Full name: x.x_create_webhook_replay_job

Parameter	Type	Required	Description
`body`	object	no	Request body for this X API operation. Use the shape documented by the official operation schema.

delete_webhooks Write

Delete webhook

Lua path: app.integrations.x.delete_webhooks
Full name: x.x_delete_webhooks

Parameter	Type	Required	Description
`webhook_id`	string	yes	The ID of the webhook to delete.

validate_webhooks Write

Validate webhook

Lua path: app.integrations.x.validate_webhooks
Full name: x.x_validate_webhooks

Parameter	Type	Required	Description
`webhook_id`	string	yes	The ID of the webhook to check.