xapi
xapi dm
Manage X direct messages.
xapi dm conversations
List your DM conversations.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 20 | Maximum conversations to return |
Output
| Field | Type | Required | Description |
|---|---|---|---|
conversations | array | yes | |
conversations[].dm_conversation_id | string | yes | |
conversations[].participant_ids | array | yes | |
count | number | yes |
Examples
# List your DM conversations
xapi dm conversationsxapi dm send
Send a direct message to a user.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
participantId | string | yes | User ID to send message to |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--text | string | Message text |
Output
| Field | Type | Required | Description |
|---|---|---|---|
dm_conversation_id | string | yes | |
dm_event_id | string | yes |
Examples
# Send a DM to a user
xapi dm send 12345 --text Hey there!xapi lists
Manage and browse X lists.
xapi lists add-member
Add a member to an X list.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID |
member | string | yes | Member to target (username with or without @, or user ID) |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
member_id | string | yes | |
member_username | string | no | |
is_member | boolean | yes |
Examples
# Add @jack to a list
xapi lists add-member 1234567890 jackxapi lists create
Create a new list.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | List name (1-25 characters) | |
--description | string | Optional list description (1-100 characters) | |
--private | boolean | false | Create as a private list |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | yes |
Examples
# Create a private list
xapi lists create --name Core devs --description Builders only --private truexapi lists delete
Delete a list by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID to delete |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
deleted | boolean | yes | |
id | string | yes |
Examples
# Delete a list
xapi lists delete 1234567890xapi lists get
Get a list by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | yes | |
description | string | no | |
owner_id | string | no | |
member_count | number | no |
Examples
# Get list details
xapi lists get 1234567890xapi lists members
List members of an X list.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 100 | Maximum members to return |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# List all members
xapi lists members 1234567890xapi lists posts
Get posts from an X list.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 25 | Maximum posts to return |
--verbose | boolean | Show full text |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].author_id | string | no | |
posts[].created_at | string | no | |
posts[].likes | number | no | |
count | number | yes |
Examples
# Get posts from a list
xapi lists posts 1234567890xapi lists remove-member
Remove a member from an X list.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | List ID |
member | string | yes | Member to target (username with or without @, or user ID) |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
member_id | string | yes | |
member_username | string | no | |
is_member | boolean | yes |
Examples
# Remove @jack from a list
xapi lists remove-member 1234567890 jackxapi posts
Manage and search X posts.
xapi posts bookmark
Bookmark a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to bookmark |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
bookmarked | boolean | yes | |
id | string | yes |
Examples
# Bookmark a post
xapi posts bookmark 1234567890xapi posts create
Create a new post.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--text | string | Post text | |
--replyTo | string | Reply to post ID | |
--quote | string | Quote post ID |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
text | string | yes |
Examples
# Post a simple message
xapi posts create --text Hello world!
# Reply to a post
xapi posts create --text Great point! --replyTo 1234567890xapi posts delete
Delete a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to delete |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
deleted | boolean | yes | |
id | string | yes |
Examples
# Delete a post
xapi posts delete 1234567890xapi posts get
Get a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--verbose | boolean | Show full text without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
text | string | yes | |
author_id | string | no | |
created_at | string | no | |
likes | number | no | |
retweets | number | no | |
replies | number | no |
Examples
# Get a post by ID
xapi posts get 1234567890xapi posts like
Like a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to like |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
liked | boolean | yes | |
id | string | yes |
Examples
# Like a post
xapi posts like 1234567890xapi posts likes
List users who liked a post.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 100 | Maximum users to return |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# See who liked a post
xapi posts likes 1234567890xapi posts retweet
Retweet a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to retweet |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
retweeted | boolean | yes | |
id | string | yes |
Examples
# Retweet a post
xapi posts retweet 1234567890xapi posts retweets
List users who retweeted a post.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 100 | Maximum users to return |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# See who retweeted a post
xapi posts retweets 1234567890xapi posts search
Search recent posts.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | Search query |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 10 | Maximum results to return (10–100) |
--sort | string | recency | Sort order |
--verbose | boolean | Show full text without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].created_at | string | no | |
posts[].likes | number | no | |
posts[].retweets | number | no | |
count | number | yes |
Examples
# Search for TypeScript posts
xapi posts search TypeScript
# Search by relevance
xapi posts search AI --sort relevancy --maxResults 20xapi posts unbookmark
Remove bookmark from a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to unbookmark |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
bookmarked | boolean | yes | |
id | string | yes |
Examples
# Remove a bookmark from a post
xapi posts unbookmark 1234567890xapi posts unlike
Unlike a post by ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Post ID to unlike |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
liked | boolean | yes | |
id | string | yes |
Examples
# Unlike a post
xapi posts unlike 1234567890xapi timeline
View your X timeline.
xapi timeline home
View your home timeline.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 25 | Maximum posts to return (5–100) |
--sinceId | string | Only return posts newer than this post ID | |
--verbose | boolean | Show full text without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].author_id | string | no | |
posts[].created_at | string | no | |
posts[].likes | number | no | |
posts[].retweets | number | no | |
count | number | yes |
Examples
# View your home timeline
xapi timeline home
# View 50 posts
xapi timeline home --maxResults 50
# Resume from last-seen post ID
xapi timeline home --sinceId 1900123456789012345xapi timeline mentions
View your recent mentions.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 25 | Maximum mentions to return |
--sinceId | string | Only return mentions newer than this post ID | |
--verbose | boolean | Show full text without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].author_id | string | no | |
posts[].created_at | string | no | |
count | number | yes |
Examples
# View your recent mentions
xapi timeline mentions
# Resume mentions from last-seen post ID
xapi timeline mentions --sinceId 1900123456789012345xapi trends
Explore trending topics on X.
xapi trends location
Get trending topics for a specific location (WOEID).
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
woeid | string | yes | Where On Earth ID (from trends places) |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
trends | array | yes | |
trends[].name | string | yes | |
trends[].query | string | yes | |
trends[].tweet_volume | number | no | |
count | number | yes |
Examples
# Get worldwide trends
xapi trends location 1
# Get trends for New York
xapi trends location 2459115xapi trends places
List places where trending topics are available.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
places | array | yes | |
places[].woeid | number | yes | |
places[].name | string | yes | |
places[].country | string | yes | |
count | number | yes |
Examples
# List all trending places
xapi trends placesxapi users
Look up X users.
xapi users block
Block a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
blocking | boolean | yes |
Examples
# Block @jack
xapi users block jackxapi users follow
Follow a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
following | boolean | yes | |
pending_follow | boolean | no |
Examples
# Follow @jack
xapi users follow jackxapi users followers
List followers of a user. Supports optional client-side baseline diffing for new follower detection.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 100 | Maximum followers to return |
--seenIdsFile | string | Path to newline-delimited follower IDs used as a baseline for client-side diffing | |
--newOnly | boolean | false | Return only followers not found in --seen-ids-file (client-side baseline diff; not API-native since_id) |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# List followers of jack
xapi users followers jack
# Show only followers not in your baseline file (client-side diffing; the X API does not support since_id here)
xapi users followers jack --seenIdsFile ./seen-followers.txt --newOnly truexapi users following
List accounts a user is following.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 100 | Maximum accounts to return |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# List accounts jack follows
xapi users following jackxapi users get
Get a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--verbose | boolean | Show full bio without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | yes | |
username | string | yes | |
description | string | no | |
followers | number | no | |
following | number | no | |
tweets | number | no | |
joined | string | no |
Examples
# Get a user by username
xapi users get jack
# Get a user by ID
xapi users get 12345xapi users me
Get the authenticated user profile and metrics.
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--verbose | boolean | Show full bio without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | yes | |
username | string | yes | |
description | string | no | |
followers | number | no | |
following | number | no | |
tweets | number | no | |
joined | string | no |
Examples
# Get your authenticated profile
xapi users mexapi users mentions
List recent mentions of a user.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 10 | Maximum mentions to return |
--verbose | boolean | Show full text |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].created_at | string | no | |
count | number | yes |
Examples
# Get mentions of jack
xapi users mentions jackxapi users mute
Mute a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
muting | boolean | yes |
Examples
# Mute @jack
xapi users mute jackxapi users posts
List a user's posts.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--maxResults | number | 10 | Maximum posts to return |
--verbose | boolean | Show full text without truncation |
Output
| Field | Type | Required | Description |
|---|---|---|---|
posts | array | yes | |
posts[].id | string | yes | |
posts[].text | string | yes | |
posts[].created_at | string | no | |
posts[].likes | number | no | |
posts[].retweets | number | no | |
count | number | yes |
Examples
# Get jack's recent posts
xapi users posts jackxapi users search
Search for users by keyword.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | Search query |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_BEARER_TOKEN | string | no | ||
X_ACCESS_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
users | array | yes | |
users[].id | string | yes | |
users[].name | string | yes | |
users[].username | string | yes | |
users[].followers | number | no | |
count | number | yes |
Examples
# Search for users about TypeScript
xapi users search TypeScriptxapi users unblock
Unblock a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
blocking | boolean | yes |
Examples
# Unblock @jack
xapi users unblock jackxapi users unfollow
Unfollow a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
following | boolean | yes |
Examples
# Unfollow @jack
xapi users unfollow jackxapi users unmute
Unmute a user by username or ID.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Username (with or without @) or user ID |
Environment Variables
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X_ACCESS_TOKEN | string | yes | X OAuth 2.0 user access token (required for write endpoints) | |
X_BEARER_TOKEN | string | no |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
username | string | yes | |
muting | boolean | yes |
Examples
# Unmute @jack
xapi users unmute jack