INinkbox
Text Messages

List Conversations

get/api/v1/phone/numbers/{phone_number_id}/texts/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/phone/numbers/{phone_number_id}/texts/conversations
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

phone_number_idstring uuid required

Query parameters

limitinteger
offsetinteger
include_groupsboolean

Default false hides group conversations from the listing — old clients see only 1:1 threads, byte-for-byte the same as before. Pass true to also include group threads.

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

remote_phone_numberstring nullable
idstring uuid nullable
participantsstring[] nullable
is_groupboolean nullable
latest_textstring nullable required
latest_direction'inbound' | 'outbound' required
latest_type'sms' | 'mms' required
latest_has_mediaboolean
latest_message_atstring date-time required
unread_countinteger required
total_countinteger required

Changes

No recorded changes to this operation across all 38 revisions of this API.