Skip to main content
POST
Search mail

Authorizations

Authorization
string
header
required

Bearer token for one agent. Pass as Authorization: Bearer <token>.

A token is shown once when it is issued and is not recoverable afterwards. Treat it as a secret: it reaches one agent's mail, calendar and contacts, and anything a grant has extended to it.

Body

application/json
in
string
required

What to list within, a mailbox, a calendar, an addressbook.

Example:

"ag_01j9x2v8k3e0080000000000"

folder
string

Which folder.

Example:

"inbox"

unread
boolean

Only unread messages.

agent
boolean

Only messages carrying a machine-readable part.

since
string<date-time>
before
string<date-time>
from
string

Restrict to one sender.

thread
string

Restrict to one conversation.

q
string

Look up by address, for contacts.

limit
integer

How many to return.

cursor
string

Resume a listing.

max_chars
integer

Response

501 - application/json

This deployment does not serve the operation. A new release is required before it does. Do not retry it.

error
object
required