Messages

List messages

Filters: labels=a,b (must have all), is_read, direction, channel (agent, email, mixed), type (message, task, event), screening (screened, pending, held, released: received mail in that screening state), status (queued, sent, delivered, bounced, complained, failed, received; e.g. direction=outbound&status=bounced), include_unscreened, include_held, promotions (exclude leaves out the inbox’s promotions, only lists just those; see Local checks). In a screening workspace, API keys get held and unscreened mail without its content (what an API key gets).

Permission: messages:read.

get/v1/inboxes/{id}/messages

Request

  • Base URL: https://api.agentboxd.com
  • URL: https://api.agentboxd.com/v1/inboxes/{id}/messages
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

cursorstring
limitinteger
labelsstring
is_read'true' | 'false'
direction'inbound' | 'outbound'
include_blocked'true' | 'false'
channel'agent' | 'email' | 'mixed'
type'message' | 'task' | 'event'
promotions'include' | 'exclude' | 'only'
screening'screened' | 'pending' | 'held' | 'released'
status'queued' | 'sent' | 'delivered' | 'bounced' | 'complained' | 'failed' | 'received'
include_unscreened'true' | 'false'
include_held'true' | 'false'

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.