Inbox
List comments and mentions
Comments on the accounts' posts and mentions of them, newest first, read from each platform about every 15 minutes.
GET
/v1/inboxTL;DR
| Question | Answer |
|---|---|
| What does it do? | List comments and mentions. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | status, accountId, postId, limit, startingAfter in the query string. |
| What does it return? | Status 200 with a body of type InboxList. |
| In the SDK? | flung.inbox.list() |
| As an MCP tool? | list_inbox |
| What can go wrong? | 401 Missing, unknown, revoked or expired API key; 422 The request failed validation; 429 Too many requests for this credential; wait for retry-after seconds. Every failure has the same error shape. |
What it does
Comments on the accounts' posts and mentions of them, newest first, read from each platform about every 15 minutes. For the next page pass the last id as startingAfter while hasMore is true.
Example
bash
curl -X GET 'https://api.flung.dev/v1/inbox' \ --header "Authorization: Bearer $FLUNG_API_KEY"ts
import { Flung } from '@flung.dev/sdk'
const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })const result = await flung.inbox.list()js
const response = await fetch('https://api.flung.dev/v1/inbox', { method: 'GET', headers: { 'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`, },})if (!response.ok) throw new Error((await response.json()).error.message)const result = await response.json()A successful answer looks like this:
json
{ "data": [ { "id": "ibx_aaaaaaaaaaaaaaaaaaaaaaaa", "accountId": "string", "platform": "x", "kind": "comment", "status": "unread", "text": "string", "author": {}, "url": "string", "platformItemId": "string", "platformPostId": "string", "targetId": "string", "createdAt": "2026-11-01T09:00:00.000Z", "repliedAt": "2026-11-01T09:00:00.000Z" } ], "hasMore": true}Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
status | "unread" | "read" | "replied" | "archived" | no | |
accountId | string | no | |
postId | string | no | Only comments on this Flung post. |
limit | integer | no | |
startingAfter | string | no |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | A page of items. | InboxList |
| 401 | Missing, unknown, revoked or expired API key. | Error |
| 422 | The request failed validation. | Error |
| 429 | Too many requests for this credential; wait for retry-after seconds. | Error |
Response body
A 200 answer has the type InboxList.
| Field | Type | Required | Description |
|---|---|---|---|
data | InboxItem[] | yes | |
data[].id | string | yes | |
data[].accountId | string | yes | |
data[].platform | Platform | yes | |
data[].kind | "comment" | "mention" | yes | comment: a reply to one of the account's posts. mention: the account named elsewhere. |
data[].status | "unread" | "read" | "replied" | "archived" | yes | |
data[].text | string | yes | |
data[].author | object | yes | |
data[].author.id | string | yes | |
data[].author.name | string | null | yes | |
data[].author.handle | string | null | yes | |
data[].url | string | null | yes | |
data[].platformItemId | string | yes | |
data[].platformPostId | string | null | yes | The platform post it answers. |
data[].targetId | string | null | yes | The Flung post target it answers, when that post went out through Flung. |
data[].createdAt | string | yes | |
data[].repliedAt | string | null | yes | |
hasMore | boolean | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint |
| Schemas | Every request and response type |
| Errors | Every error code and what to do about it |
list_inbox | The same operation as an MCP tool |