x_api_search_users
Search X users by query, with optional max results and pagination, requiring authenticated OAuth credentials.
Instructions
Search Users. Use when: Search Users. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: read-only. Required permissions and prerequisites: OAuth 2 user token with scopes tweet.read, users.read; OAuth 1a user token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: query (query, unknown, required); max_results (query, integer); next_token (query, unknown). Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_get_scope_credentials, x_api_request. Safety warnings: This is read-only, but responses can still include sensitive account data depending on granted scopes. Example: {"name":"x_api_search_users","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| next_token | No | ||
| max_results | No | ||
| scopeUserId | No | ||
| credentialKey | No | ||
| scopeTenantId | No | ||
| scopeAccountId | No | ||
| authorizationKey | No | ||
| preferredAuthType | No |