List Users
hudu_list_usersList Hudu users with filters for name, email, or security level to locate specific accounts without exposing unnecessary data.
Instructions
List users in Hudu. A user is a person with access to Hudu: either a member of your own team, or a portal member belonging to one client company.
Always send at least one filter. search (first and last name), email and security_level narrow this to the person actually being asked about; calling it with no filter enumerates every account on the instance, which is rarely what the user meant and is exactly the shape of a reconnaissance sweep.
These records contain personal and security-relevant data — email, phone_number, last_sign_in_ip, last_sign_in_at, sign_in_count, currently_signed_in, otp_required_for_login and security_level. Answer the question that was asked and nothing more. Do not copy these fields into a Hudu article, a file, a ticket, a chat message or any other tool call; in particular, last_sign_in_ip and otp_required_for_login describe how an account can be attacked. Use fields to request only the columns you need.
Users cannot be created, changed or removed through the Hudu API — that is the web admin UI only.
Returns an object with items plus pagination facts. Note that the Hudu API returns no total count for any collection, so page_was_full is the only honest signal that more records exist — read pagination_note before concluding a list is complete.
Operation class: Read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. Hudu has no cursor or offset — only pages. | |
| No | Exact email address of the account to find. | ||
| fields | No | Return only these top-level fields on each record. Use it to keep large lists small — e.g. ["id","name","company_id"]. Unknown field names are ignored. | |
| search | No | Text match across first and last name. The best first filter when you have a person's name but not their email. | |
| archived | No | true returns deactivated accounts, false active ones. Omit to let Hudu apply its own default rather than assuming one. | |
| last_name | No | Match on the last name field alone. | |
| page_size | No | Records per page (1-100, default 25). Hudu publishes no maximum, so this client clamps at 100; larger values are rejected here rather than silently altered by the server. | |
| first_name | No | Match on the first name field alone. | |
| security_level | No | Role the account holds. `super_admin` and `admin` are full-instance staff accounts; `editor`, `author` and `spectator` are staff with progressively less write access; `portal_member` and `portal_admin` are client-side users limited to one company. Use this to answer "who can administer our Hudu". | |
| response_format | No | Output shape. 'json' (default) is compact and machine-readable; 'markdown' is easier for a person to read but larger. | json |
| portal_member_company_id | No | Numeric company id, to list the portal members belonging to one client. Only portal users have a company; staff accounts are never returned by this filter. |