Skip to main content
GET
List the things to process received by mail

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"]):

  • "mail": Include the mail this item came out of (door, sender, subject, reception date).
  • "actions-info": Adds actions { canBeDismissed, canBeDeleted, canBecomeReport }.
  • "download-url": Adds a presigned downloadUrl for the item's file, before any conversion.
  • "latest-analysis": Newest analysis run of the item (null when it has none), with the provider and unit its succeeded metadata step retained and the score each was retained on.
  • "sender-provider": Provider the sending address belongs to, when exactly one live contact of the organization carries it - the attribution that comes from the mail thread rather than from the document. Null when no contact, or contacts of several providers, answer to that address.
  • "report": Report this item became (null while it is still unprocessed), named by its document and placed on the first unit its compliances cover.
Available options:
mail,
actions-info,
download-url,
latest-analysis,
sender-provider,
report
orderBy
object[]

Case-insensitive partial match on the carrying mail's subject or sender address.

Maximum string length: 200
Example:

"lobby"

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:
whereType
string[]

Filter by what the received document is.

Example:
whereStatus
string[]

Filter by processing status - pending is the work queue.

Example:
whereSource
string[]

Filter by the door the document came through - a provider mail, or a manual import.

Example:
whereMailIds
string<uuid>[]

Filter by the mail the items came out of.

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:
whereFromEmail
string

Filter by the sender of the mail (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

whereReceivedAt
object

Filter by the reception date of the mail.

Example:

Response

Default Response

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