Search captured mail and PEC (module status)
Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.
Find archived messages across the mailboxes this member may see. Filters on free text (subject, sender, snippet), direction, mailbox, PEC type and a date window. Returns summaries — subject, sender, date, whether it has attachments — never the bodies; use email_get for one message. At most 100 per call.
Examples
- Any PEC from the Agenzia delle Entrate this month? GET /api/v1/rest/email/status?query=agenziaentrate&pec_only=true
- Unread mail with attachments GET /api/v1/rest/email/status?unread_only=true&has_attachments=true
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/email/status
- Auth: HTTP bearer
Query parameters
Free text over subject, sender address and the snippet.
One mailbox. Omit for all you may see.
inbound for received mail, outbound for the archived copies of sent mail.
Only PEC messages and their receipts (legally significant mail).
Rows to return, 1–100. Default 20.
Opaque cursor from a previous call’s nextCursor, to continue.
Headers
The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.
Response
Done. data is the tool’s own answer.
Changes
No recorded changes to this operation across all 1 revision of this API.