Skip to main content
GET
Get Direct Messages Events

Authorizations

Authorization
string
header
required

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

Query Parameters

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

A base32hex-encoded pagination token.

Minimum string length: 16
event_types
enum<string>[]
Minimum array length: 1
Available options:
MessageCreate,
ParticipantsJoin,
ParticipantsLeave
dm_event.fields
enum<string>[]

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

Minimum array length: 1
Available options:
attachments,
created_at,
dm_conversation_id,
entities,
event_type,
id,
text
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
attachments.media_keys,
attachments.media_keys,
participant_ids,
referenced_posts,
sender_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,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld
post.fields
enum<string>[]

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

Minimum array length: 1
Available options:
article,
article_title,
attachments,
card_uri,
community_id,
context_annotations,
conversation_id,
created_at,
display_text_range,
edit_controls,
entities,
geo,
id,
lang,
matched_media_notes,
media_metadata,
non_public_metrics,
note_post,
note_request_suggestions,
organic_metrics,
paid_partnership,
possibly_sensitive,
promoted_metrics,
public_metrics,
reply_settings,
scopes,
source,
suggested_source_links,
suggested_source_links_with_counts,
text,
withheld
media.fields
enum<string>[]

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

Minimum array length: 1
Available options:
alt_text,
duration_ms,
height,
media_key,
non_public_metrics,
organic_metrics,
preview_image_url,
promoted_metrics,
public_metrics,
type,
url,
variants,
width

Response

The request has succeeded.

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