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

​
status
enum<string>

Only messages with this status: scheduled, sent, delivered, failed, received (inbound) or unknown.

Available options:
scheduled,
sent,
delivered,
failed,
received,
unknown
​
channel
enum<string>

Only messages sent or received on this channel: sms, mms or rcs. This is the channel actually used, so an SMS that was upgraded to MMS appears under mms.

Available options:
sms,
mms,
rcs
​
direction
enum<string>

out for messages you sent, in for messages your numbers received.

Available options:
out,
in
​
to
string

Recipient number to filter on, in E.164 format, exact match. For inbound messages this is your number.

​
from
string

Sender to filter on, exact match: one of your numbers in E.164 format (for example +14155550100), or the senderName of your RCS sender for RCS messages. For inbound messages this is the contact's number.

​
tag
string

Only messages whose tag equals this value, exact match. Set the same tag on related sends to retrieve them together.

​
startDate
string<date-time>

Only messages created at or after this time, as an RFC 3339 / ISO 8601 timestamp such as 2026-10-01T00:00:00Z.

​
endDate
string<date-time>

Only messages created before this time, as an RFC 3339 / ISO 8601 timestamp such as 2026-11-01T00:00:00Z. Combine with startDate for a date range.

​
limit
integer
default:20

Maximum number of messages 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 records 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 messages.

One page of messages from GET /messages, with the total number of matches so you can page through the rest.

​
messages
object[]

The messages on this page, newest first. An empty array when nothing matches.

​
total
integer

Total number of messages that match your filters across all pages. Stop paging when offset plus the page length reaches it.

Example:

128

​
limit
integer

The limit you sent in the request, or 0 when you omitted it. The page itself holds at most 100 messages, and 20 when limit is omitted.

Example:

20

​
offset
integer

The number of messages skipped before this page, as sent in the request.

Example:

0