List Expirations
hudu_list_expirationsGet all dated expirations for a client in one list—domains, SSL certificates, warranties, asset date fields, and article reviews. Filter by company ID to see what expires soon.
Instructions
List expirations in Hudu. An expiration is a dated thing that will stop working: a domain registration, an SSL certificate, a hardware warranty, a date field on an asset, or an article review date.
This is the single call that answers "what is about to expire for this client". Hudu gathers expiry dates from across every module into one list, so you do not have to walk websites, then assets, then articles separately. Filter by company_id for one client and read the date field on each entry.
Each entry points at the thing that expires through expirationable_type and expirationable_id rather than embedding it — so once you have found the interesting entries, fetch the underlying record with the matching tool (hudu_get_website, hudu_get_asset, hudu_get_article) to get its name and details.
There is no date-range filter: Hudu returns the entries and this server passes them through unchanged, so compare date yourself rather than expecting the API to have narrowed to "the next 30 days". Entries are not filtered by whether they have already passed either — a date in the past means something has already expired.
Expirations are read-only through the API. To change one, edit the record that produced it: the website's expiry, the asset field's date, and so on.
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. | |
| 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. | |
| 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. | |
| company_id | No | Numeric company id, to scope the list to one client. The usual first filter — resolve a customer name to an id with hudu_list_companies. | |
| resource_id | No | Numeric id of a specific record, to see only its expirations. Must be sent together with `resource_type`. | |
| resource_type | No | Hudu record type, written exactly as Hudu spells it: "Asset", "AssetPassword", "Company", "Article", "Website" and so on. Must be sent together with the matching id — either one alone is ignored. | |
| expiration_type | No | Kind of expiry to return. `domain` is a domain registration and `ssl_certificate` a TLS certificate, both from website records; `warranty` is hardware support cover on an asset; `asset_field` is a custom date field on an asset layout; `article_expiration` is a documentation review date; `undeclared` covers entries Hudu has not categorised. | |
| response_format | No | Output shape. 'json' (default) is compact and machine-readable; 'markdown' is easier for a person to read but larger. | json |