Sign in
iMessage

List Conversations

get/api/v1/imessage/conversations

Query parameters

agent_identity_idstring uuid nullable
limitinteger
offsetinteger
is_blockedboolean nullable
include_groupsboolean
start_datetimestring nullable

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

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.

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.

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

Response

Successful Response

idstring uuid required
assignment_idstring uuid nullable required
assignment_status'active' | 'released' required
remote_numberstring nullable required
participantsstring[] nullable
is_groupboolean
group_creation_status'creating' | 'not_created' | 'ready'
latest_textstring nullable
latest_message_atstring date-time nullable
latest_direction'inbound' | 'outbound'
latest_has_mediaboolean
unread_countinteger
total_countinteger

Changes

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