Skip to main content
GET
List Sms Threads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
sort_by
enum<string>
default:latest_message_at
Available options:
latest_message_at,
partner_name,
created_at,
last_inbound_at,
last_outbound_at
sort_order
enum<string>
default:desc
Available options:
asc,
desc
partner_id
string | null
search
string | null
partner_id__in
string[] | null
assignee_id__in
string[] | null
business_unit_id__in
string[] | null

Filter by business unit IDs

Response

Successful Response

data
SMSThreadSummary · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.