Skip to main content
GET
List SMS Messages

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

user_id
string | null

Show only messages where this user either sent or received the message.

from_user_id
string | null

Show only messages sent by this user.

to_user_id
string | null

Show only messages received by this user.

from_number
string | null

Show only messages sent from this phone number.

to_number
string | null

Show only messages sent to this phone number.

number
string | null

Show only messages that involve this phone number, whether it sent or received.

direction
string | null

Show only 'inbound' messages (received) or 'outbound' messages (sent).

status
integer | null

Show only messages in this state: 1 = waiting to send, 2 = sent, 3 = delivered, 4 = failed, 5 = received.

limit
integer
default:50

How many messages to return per page (1 to 200).

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

How many messages to skip before this page starts.

Required range: x >= 0

Response

Successful Response

Standard response wrapper for list responses.

Declare ListResponse[list[SomeModel]] to render the real data array schema in OpenAPI/Swagger; a bare ListResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.

row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
next_cursor
string | null

Cursor for the next page, if available.