b24_user_get
Read-onlyIdempotent
Find Bitrix24 users using filters like ID, name, email, department, and active status. Supports pagination and sorting to manage large result sets.
Instructions
Find users (user.get) with a real filter and pagination.
Filter keys include ID, ACTIVE ('Y'/'N'), NAME, LAST_NAME, EMAIL, UF_DEPARTMENT, WORK_POSITION, and '%'-prefixed substring variants (e.g. {'%LAST_NAME': 'Ivan'}). Always filter to keep the result bounded.
Returns: JSON pagination envelope {items, count, total, next, has_more, truncated}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Shortcut to fetch one user by id (merged into the filter as ID). | |
| order | No | Sort object, e.g. {'ID':'DESC'} or {'DATE_CREATE':'ASC'}. | |
| start | No | Pagination offset (page size is 50). Use 'next' from a prior response. | |
| filter | No | Bitrix filter object. Keys may carry operator prefixes: '>', '<', '>=', '<=', '!', '%' (substring), '=%', e.g. {">=DATE_CREATE": "2026-01-01", "%TITLE": "draft"}. | |
| 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. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |