Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

inbox_id
string<uuid>
required

Email inbox UUID.

Query Parameters

filter[from]
string

Case-insensitive literal substring of the sender address.

filter[subject]
string

Case-insensitive literal substring of the subject.

filter[received_after]
string<date-time>

Inclusive ISO 8601 lower bound for the received timestamp.

filter[received_before]
string<date-time>

Inclusive ISO 8601 upper bound for the received timestamp.

filter[read]
boolean

Whether the message has a read timestamp.

filter[unread]
boolean

Whether the message has no read timestamp. Set to true to return only unread messages.

filter[label]
string

Returns only messages carrying this label. Matching is exact and case-sensitive. Reserved telnyx: labels can be filtered on even though they cannot be written by customers.

Maximum string length: 255

Full-text query over subject and body, up to 500 characters.

Maximum string length: 500
page[size]
integer
default:25

Number of results to return. Defaults to 25; maximum is 100.

Required range: 1 <= x <= 100
page[after]
string

Opaque cursor returned by the previous page.

Response

Paginated inbox messages.

data
object[]
required
meta
object
required