b24_user_search
Search Bitrix24 users by free-text query across name, last name, email, or position. Returns paginated user objects with optional auto-pagination.
Instructions
Free-text search for users (user.search).
Better than user.get when you only have a partial name. Returns a pagination envelope of user objects.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Free-text search across name/last name/email/position (FIND). | |
| start | No | Pagination offset (page size is 50). Use 'next' from a prior response. | |
| fetch_all | No | Auto-paginate and return all matching records (capped by BITRIX_MAX_PAGES, default 40 pages = 2000 records). Use a filter to keep this bounded. | |
| only_active | No | Restrict to active users. | |
| webhook_url | No | Override the default incoming webhook for this call (https://<portal>/rest/<user_id>/<token>/). If omitted, uses personal_webhook, then the X-B24-Webhook HTTP header, then the BITRIX_WEBHOOK_URL env default. | |
| personal_webhook | No | Act as a specific user (their personal incoming webhook). Takes precedence over webhook_url. Required to write to the portal under that user's permissions. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |