API: Search user accounts
| Target URL | /api.php/Core/users/search |
| Required scope | Any valid access token. No specific scope is checked. |
| HTTP Method | GET/POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | Only for regular users, not for the superuser | Keyword to search in first name, last name or e-mail address |
Which accounts are visible follows the "users may see" permission of the account making the request. The request is refused when the account is not allowed to interact with other users. Since FileRun 2026.3.0 only person accounts are listed: regular accounts and guest accounts. Internal accounts, such as the System account, are left out.
The response
The results array holds at most 50 accounts, sorted by first name. Each entry has the following fields:
| Field | Type | Description |
|---|---|---|
| first_name | string | |
| last_name | string | |
| string | ||
| full_name | string | |
| public_id | string | The public id, which the sharing endpoints take |
| id | integer | Included only for the superuser |
| username | string | Included only for the superuser |