INinkbox
Messages

List Messages

Changed on
get/api/v1/mail/mailboxes/{email_address}/messages

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/mail/mailboxes/{email_address}/messages
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

email_addressstring required

Query parameters

cursorstring nullable
limitinteger
direction'inbound' | 'outbound'
folder'inbox' | 'spam' | 'blocked' | 'archive'

Filter by thread folder. Omit to list all.

start_datetimestring nullable

Filter created_at >= this date/datetime. Bare date => whole day in tz.

end_datetimestring nullable

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

tzstring nullable

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

Response

Successful Response

next_cursorstring nullable
has_moreboolean

Changes