Contents
View as Markdown

Inbox

4 tools. Generated from the MCP server: names, inputs and prices match the code.

List Email Inboxes

List the account's inbound email addresses, the default one first. Mail sent to `address` creates a property in `target_stage_id` (null is the default stage) for one AI credit per processed mail. `is_paused` addresses hold mail without processing it. `message_count_30d` is the mail of the last 30 days. Below the Plus plan the addresses are reserved but reject mail. Free.

Inputs

NameTypeRequiredDescription
limitintegerno
offsetintegerno

RESTGET /api/v1/inbound-mailboxes

Get Inbound Email

One received mail by id: sender, subject, attachments with size and whether each was readable, status, the reason when it could not be processed, the property it became, the AI credits it cost, and when its content is removed. The text of the mail is not returned (`body_text` is null here). Free.

Inputs

NameTypeRequiredDescription
idstringyes

RESTGET /api/v1/inbound-messages/{id}

List Inbound Emails

List the mails received on the inbound addresses, newest first, with `status` and, once processed, the `property` each became. waiting_for_credits and held_paused wait up to 30 days (`expires_at`) and are then expired; unprocessable carries `failure_code` (attachment_unreadable, no_offer_found, no_content, processing_failed). Sender, subject and content are removed 90 days after receipt (`purge_at`), the entry stays. Filter with `status` (an array of statuses) and `mailbox_id`. Free.

Inputs

NameTypeRequiredDescription
limitintegerno
offsetintegerno
statusarray<string>noOnly mails in one of these statuses: an array, or one comma-separated string. What needs attention is waiting_for_credits, held_paused and unprocessable.Values:receivedprocessingprocessedwaiting_for_creditsheld_pausedunprocessableexpired
mailbox_idstringnoOnly mails received on this address.

RESTGET /api/v1/inbound-messages

List Inbox

The account's inbox as one list, newest first, from the newest 200 mails, 100 reports, 200 inquiries, 200 first opens, 200 link requests, 200 pushes and 200 offered objects (`truncated` says when older ones exist). Each item has a `kind`: `mail` (`message`), `due_diligence` (`report`), `inquiry` (`inquiry`: a message a viewer sent from a share link, with its `status` new, contacted, viewing or declined) and `share_info` (`info`: `type` first_opened when a link was opened for the first time, or new_link_request when the viewer of an expired link asked for a new one) and `push` (`push`: a listing a seller sent to the person as their customer, with the seller's brand, the asking price, and `response` calculated or not_interested) and `submission` (`submission`: an object a broker offered through the person's public investor page, with the link, the submitter's name, company and email as typed, never verified, and `status` received, accepted or declined). Mails, inquiries, share notices, pushes and offered objects are listed on every plan. Reports need the Max 5x plan or higher over a connector, API key or OAuth grant; `agent_rows_included` false means they were left out of this list, which the user should be told. Free.

Inputs

NameTypeRequiredDescription
limitintegerno
offsetintegerno
kindsarray<string>noOnly rows of these kinds: an array, or one comma-separated string of due_diligence, mail, inquiry, share_info, push, submission. Default: all. An empty value lists no rows.Values:due_diligencemailinquiryshare_infopushsubmission
attentionbooleannotrue lists only what waits for the owner: mails in waiting_for_credits, held_paused or unprocessable, unread inquiries in status new, unread requests for a new link, pushed listings not opened or answered yet, and offered objects in status received.
mail_statusarray<string>noOnly mails in one of these statuses. Lists mails only, each as its own row: no reports, inquiries or share notices.Values:receivedprocessingprocessedwaiting_for_creditsheld_pausedunprocessableexpired
mailbox_idstringnoOnly mails received on this inbound address. Lists mails only, like mail_status.

RESTGET /api/v1/inbox