DM Inbox API

GET dm/list returns the Direct Message inbox for the account behind your session: a list of DM conversations, each with its conversation_id, type, and participant user IDs. It is read-only and does not send messages or return message content. The response includes a count field alongside the conversations array. Use the returned conversation_id values with GET /dm/conversation to read a specific thread's messages.

curl -X GET "https://example.com/dm/list"

{  "count": 2,  "conversations": [    {      "conversation_id": "1749154312754794496-1972455697997824000",      "type": "ONE_TO_ONE",      "participants": [        "1749154312754794496",        "1972455697997824000"      ]    },    {      "conversation_id": "1796873533852692480-1972455697997824000",      "type": "ONE_TO_ONE",      "participants": [        "1796873533852692480",        "1972455697997824000"      ]    }  ]}

{  "error": "bad_request",  "message": "Missing or malformed parameter. Fix the request before retrying."}

{  "error": "unauthorized",  "message": "The API key is missing, malformed, or revoked. Check the Authorization header."}

{  "error": "insufficient_credits",  "message": "Your balance is exhausted. Top up your credits to continue."}

{  "error": "not_found",  "message": "The resource does not exist, for example a deleted tweet or a private account."}

{  "error": "rate_limited",  "message": "Too many requests. Back off and retry with exponential backoff."}

{  "error": "server_error",  "message": "Something failed on our side. Retry with backoff; if it persists, contact support."}

Pricing

When to use

Use GET dm/list to enumerate the DM inbox itself, the set of conversations, their IDs, types, and participants, before drilling into any single thread. Once you have a conversation_id from this response, pass it to GET /dm/conversation to pull that thread's actual messages.

Notes

• Needs a session for the account you are reading: either register one once (POST /customer/session), or pass per-call inline credentials as x-auth-token and x-ct0 request headers, which let a single API key act as many accounts. Returns 409 session_required if neither is supplied, 401 session_dead when the session has expired.
• Not cursor-paginated: the inbox is returned in a single page.
• Read-only: lists conversations; it does not send DMs.

Related endpoints

• Send DM: Send a direct message from your authenticated account.
• DM Conversation: Read the message history of one DM conversation by conversation_id.

FAQ

Does dm/list return the actual message text inside each conversation?

No. Each entry in the conversations array only carries conversation_id, type, and participants. To read the messages in a specific conversation, take its conversation_id and call GET /dm/conversation.

What account's inbox does this endpoint read, and can I pass a target user?

There are no params on this endpoint, it always returns the DM conversations for the account tied to your current session, not an arbitrary user's inbox. Each call costs $0.0016 and returns a count field plus the conversations array.