AI Inbox

Get Inbox Mailbox Sync

Is this mailbox being polled, and how did the last round go.

A mailbox that was never connected is not an error - it answers {"status": "STOPPED"}.

NOTE the asymmetry this proxy has to respect: the internal handler takes NO current_user, while its siblings do. Supplying one would be a TypeError on every call.

get/inbox/mailboxes/{mailbox}/sync

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/inbox/mailboxes/{mailbox}/sync
  • Auth: HTTP bearer

Path parameters

mailboxstring required

The mailbox ADDRESS, e.g. sales@acme.com. Not a numeric id.

Query parameters

provider'google_mailbox' | 'smtp' required

How the mailbox is connected. REQUIRED and not inferred: the same address can be connected either way, and guessing would act on the wrong transport. Closed to a Literal so an unknown value is a 422 naming both, rather than a ValueError raised inside the handler.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataInboxPayload required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

Changes

No recorded changes to this operation across all 2 revisions of this API.