> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Users

Search for Twitter/X users by keyword. Matches against usernames, display names, and bios. Returns user profiles sorted by relevance. Ideal for: finding accounts, user discovery, account lookup.

![Search Users logo](https://ai-icon.b3.fun/logo/x)
Catalog action Social

Search for Twitter/X users by keyword. Matches against usernames, display names, and bios. Returns user profiles sorted by relevance. Ideal for: finding accounts, user discovery, account lookup.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `x-search-users` |
| Category | Social |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `social`, `twitter`, `x`, `user`, `search`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | `string` | Yes | Search keyword to find Twitter/X users. Matches against usernames, display names, and bios. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `string` | Yes | 'success' or 'error' |
| `users` | `array` | Yes | Array of matching user profiles |
| `totalResults` | `number` | Yes | Number of users returned |
| `hasNextPage` | `boolean` | Yes | Whether more results are available |
| `nextCursor` | `string \| null` | No | Cursor for next page |
| `error` | `string` | No | Error message if status is 'error' |

## Examples

**Workflow node**

```json
{
  "type": "x-search-users",
  "payload": {
    "query": "status:open"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/x-search-users/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "query": "status:open"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.