Skip to main content
GET
Get broadcast chat history
Gets a paginated list of timestamped chat messages for a broadcast. Only accessible after the broadcast has finished. :id is the alphanumeric broadcast_id, and the authenticated user must own the broadcast. Messages are returned newest-first. Use max_results (1–200, default 100) to page, and pagination_token to continue from the meta.next_token returned by the previous response.
For live chat ingestion while a broadcast is running, use the X Activity API broadcast.chat event instead. This endpoint is for retrieving the message history after the broadcast ends.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Pattern: ^[a-zA-Z0-9]{1,13}$

Query Parameters

max_results
integer<int32>
default:100
Required range: 1 <= x <= 200
pagination_token
string

A 64-bit signed integer.

broadcast_chat_message.fields
enum<string>[]

A comma separated list of BroadcastChatMessage fields to display. The fields available for a BroadcastChatMessage object.

Minimum array length: 1
Available options:
author_name,
author_username,
broadcast_id,
created_at_ms,
id,
reply_to,
text
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
author_id
user.fields
enum<string>[]

A comma separated list of User fields to display. The fields available for a User object.

Minimum array length: 1
Available options:
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
name,
parody,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscriber_count,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld

Response

The request has succeeded.

data
object[]
errors
object[]
includes
object
meta
object