Skip to main content
GET
cURL

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Query Parameters

limit
integer
default:20

Maximum number of conversations to return, from 1 to 100. Defaults to 20; a value outside that range also returns 20.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of conversations to skip before the page starts, 0 or greater. Defaults to 0. Add the page size to it to fetch the next page.

Required range: x >= 0

Response

A page of conversations. Empty array when none.

id
string<uuid>

Unique identifier of the conversation (UUID). Pass it to the conversation endpoints; messages carry it as conversationId.

Example:

"c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04"

accountId
string

Your Vobiz account ID (Auth ID), for example MA_XXXXXXXX.

Example:

"MA_XXXXXXXX"

participantA
string

Your side of the thread: your number in E.164 format, or the senderName of your RCS sender.

Example:

"+14155550100"

participantB
string

The contact's phone number in E.164 format.

Example:

"+14155550123"

channel
enum<string>

Channel the thread runs on: sms, mms or rcs. The same two parties have a separate conversation on each channel.

Available options:
sms,
mms,
rcs
lastMessageAt
string<date-time>

Time of the latest message in the thread, sent or received (ISO 8601, UTC). Conversation lists are ordered by it, newest first.

Example:

"2026-10-16T21:23:51Z"

messageCount
integer

Total number of messages in the thread, in both directions.

Example:

3

unreadCount
integer

Number of messages added to the thread since it was last marked read. POST /conversations/{id}/read resets it to 0.

Example:

1

lastReadAt
string<date-time>

When the thread was last marked read (ISO 8601, UTC). Omitted until you first call POST /conversations/{id}/read.

Example:

"2026-10-17T08:46:55Z"

createdAt
string<date-time>

When the conversation was created, as an RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-10-16T21:23:02Z"