INinkbox
WhatsApp

List Conversations

Changed on
get/api/v1/whatsapp/conversations

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/whatsapp/conversations
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

agent_identity_idstring uuid nullable
offsetinteger
limitinteger
is_blockedboolean nullable
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

idstring uuid required
agent_identity_idstring uuid required
local_numberstring required
remote_numberstring required
participantsstring[] required
created_atstring date-time required
updated_atstring date-time required
latest_textstring nullable required
latest_message_atstring date-time nullable required
latest_direction'inbound' | 'outbound' nullable required
latest_has_mediaboolean required
unread_countinteger required
total_countinteger required

Changes