<!-- Generated by scripts/generate_endpoint_docs.py — do not edit by hand. -->
# `api.notes.suggest_users`

> `GET /note/suggestUsers` — ACPortal

**Python**

```python
api.notes.suggest_users(search_key: str, *, job_franchisee_id: str | None = None, company_id: str | None = None) -> list[SuggestedUser]
```

**CLI**

```bash
ab notes suggest_users <search_key> [--job-franchisee-id ...] [--company-id ...]
```

Suggest users for mentions (``GET /note/suggestUsers``).

``search_key`` is **required** by swagger; it is positional here so
it cannot be silently omitted.

Returns rows whose ``id`` feeds :attr:`NoteRequest.assigned_users`.

## Query parameters — `NotesSuggestUsersParams`

| Field | Type | Required | Description |
|---|---|---|---|
| `SearchKey` | `Optional[str]` | no | User search keyword (required) |
| `JobFranchiseeId` | `Optional[str]` | no | Job franchisee UUID |
| `CompanyId` | `Optional[str]` | no | Company UUID filter |

## Response

Returns a list of `List[SuggestedUser]`.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `Optional[int]` | no | Contact ID — feeds NoteRequest.assigned_users[].id |
| `fullName` | `Optional[str]` | no | Display name |

---

[← Back to api.notes](../notes.md)