Skip to main content
GET
List Messages

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

dms:read
chat:read
support_chat:read

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Sorgu Parametreleri

channel_id
string
gerekli

Filter by public channel ID. An experience ID is also accepted for experience chat.

replying_to_message_id
string

Return replies to this message.

pinned
boolean

Filter by message pin state.

include_deleted
boolean
varsayılan:false

Include redacted deletion entries for cache synchronization.

include_replying_to_message
boolean
varsayılan:false

Include the full replied-to message. Nested replies are not included.

created_after
string

Return messages created strictly after this ISO 8601 timestamp.

created_before
string

Return messages created strictly before this ISO 8601 timestamp.

updated_after
string

Return messages changed at or after this ISO 8601 timestamp in ascending change order. Cannot be combined with history filters, around anchors, order, or direction.

before_message_id
string

Filter messages strictly before this message in channel_id by creation time and message ID. Deleted anchors are accepted; missing or other-channel IDs return 404. Cannot be combined with around anchors or updated_after.

after_message_id
string

Filter messages strictly after this message in channel_id by creation time and message ID. Deleted anchors are accepted; missing or other-channel IDs return 404. Cannot be combined with around anchors or updated_after.

around_message_id
string

Center the first page around this live message in the selected channel.

around_timestamp
string

Center the first page around this ISO 8601 timestamp in the selected channel.

order
enum<string>

History sort field. Defaults to created_at. Cannot be supplied with updated_after or around anchors.

Mevcut seçenekler:
created_at,
updated_at
direction
enum<string>

History sort direction. Defaults to desc. Cannot be supplied with updated_after or around anchors.

Mevcut seçenekler:
asc,
desc
first
integer
varsayılan:20

Number of results to return from the start of the range.

Gerekli aralık: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Gerekli aralık: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Yanıt

messages listed

data
object[]
gerekli
page_info
object
gerekli