Skip to main content
GET
Get Chat Message Requests

Authorizations

Authorization
string
header
required

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

Scopes

users.read

View any account you can see, including protected accounts.

tweet.read

View all posts you can see, including those from protected accounts.

dm.read

Read all your Direct Messages.

Query Parameters

inbox_type
enum<string>
default:you_may_know

Which message request inbox to list: you_may_know (the apps' Priority tab) or low_quality (the apps' Hidden tab).

Available options:
you_may_know,
low_quality
max_results
integer<int32>
default:10

The maximum number of message requests to return.

Required range: 1 <= x <= 50
pagination_token
string

The next_token from a previous response, to fetch the next page.

Pattern: ^[0-9]{1,10}$
chat_message_request.fields
enum<string>[]

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

Minimum array length: 1
Available options:
conversation_id,
conversation_key_events,
encoded_message_create_event,
has_more_events,
message_events,
sender_id,
sender_recently_modified_profile,
social_proof_user_ids

Response

The request has succeeded.

data
object[]
errors
object[]
meta
object