Skip to content

Get Inbox Mailbox Sync

GET
/inbox/mailboxes/{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.

Authorizations

Parameters

Path Parameters

mailbox
required

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

string

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

Query Parameters

provider
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.

string
Allowed values: google_mailbox smtp

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.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string