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

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "items": Include the things to process in each mail - one per document attachment, each with its own type, status and report.
Available options:
items
orderBy
object[]
whereIds
string<uuid>[]

Filter by one or more inbox item ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereStatus
string[]

Filter by the sender-gate verdict on the message.

Example:
whereItemType
string[]

Keep mails carrying at least one item of one of these types.

Example:
whereItemStatus
string[]

Keep mails carrying at least one item in one of these statuses.

Example:
whereRejectionReason
string[]

Filter by one or more rejection reasons.

Example:

Case-insensitive partial match on the subject, the body or the sender email.

Maximum string length: 200
Example:

"lobby"

whereFromEmail
string

Filter by sender email (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

whereReceivedAt
object

Filter by reception date range.

Example:

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required