Skip to main content
GET
List inbox items

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include
enum<string>[]

Optional. Array of strings, comma-separated. Additional properties to include in the response. Accepted values: meta.abbreviation adds meta.abbreviation to each inbox item, with pre-formatted, localized strings for displaying it (date, description, attachment, amount and labels). When omitted, meta is not returned.

Available options:
meta.abbreviation
accountId
string

Optional. String. Identifier of a connected email account, the same value as the userId property of an inbox item. When given, only inbox items received through that account are returned. When omitted, inbox items from all of the user's connected accounts are returned.

Example:

"jane.doe@example.com"

max
integer<int>
default:10

max records to return

Required range: 1 <= x <= 1000
offset
integer<int>
default:0

the offset to be used in list

Required range: x >= 0

Response

OK

meta
object
required
data
object[]
required