Skip to main content
GET
List SMS Thread

Authorizations

Authorization
string
header
required

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

Query Parameters

phone_number_id
string | null

Your side: the owned phone number's id (preferred; works after delete/reassign).

number
string | null

Your side as a raw number (fallback when not a saved number).

counterpart_phone_number_id
string | null

The other party's owned phone number id (from the conversation list).

counterpart
string | null

The other party as a raw number (fallback / external numbers).

before_id
string | null

The oldest message you already loaded; returns the next-older page. Omit to get the latest messages.

limit
integer
default:200

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

Required range: 1 <= x <= 200

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.