Skip to content
Connect an agent

Inbox

Get an inbox item

Get an inbox item.

GET/v1/inbox/{id}

TL;DR

QuestionAnswer
What does it do?Get an inbox item.
What does it need?An API key or an OAuth access token.
What does it take?id in the path.
What does it return?Status 200 with a body of type InboxItem.
In the SDK?flung.inbox.get()
What can go wrong?401 Missing, unknown, revoked or expired API key; 404 No such item in this workspace; 422 The request failed validation; 429 Too many requests for this credential; wait for retry-after seconds. Every failure has the same error shape.

Example

bash
curl -X GET 'https://api.flung.dev/v1/inbox/ibx_aaaaaaaaaaaaaaaaaaaaaaaa' \  --header "Authorization: Bearer $FLUNG_API_KEY"

A successful answer looks like this:

json
{  "id": "ibx_aaaaaaaaaaaaaaaaaaaaaaaa",  "accountId": "string",  "platform": "x",  "kind": "comment",  "status": "unread",  "text": "string",  "author": {    "id": "string",    "name": "string",    "handle": "string"  },  "url": "string",  "platformItemId": "string",  "platformPostId": "string",  "targetId": "string",  "createdAt": "2026-11-01T09:00:00.000Z",  "repliedAt": "2026-11-01T09:00:00.000Z"}

Path parameters

FieldTypeRequiredDescription
idstringyes

Responses

StatusMeaningBody
200The item.InboxItem
401Missing, unknown, revoked or expired API key.Error
404No such item in this workspace.Error
422The request failed validation.Error
429Too many requests for this credential; wait for retry-after seconds.Error

Response body

A 200 answer has the type InboxItem.

FieldTypeRequiredDescription
idstringyes
accountIdstringyes
platformPlatformyes
kind"comment" | "mention"yescomment: a reply to one of the account's posts. mention: the account named elsewhere.
status"unread" | "read" | "replied" | "archived"yes
textstringyes
authorobjectyes
author.idstringyes
author.namestring | nullyes
author.handlestring | nullyes
urlstring | nullyes
platformItemIdstringyes
platformPostIdstring | nullyesThe platform post it answers.
targetIdstring | nullyesThe Flung post target it answers, when that post went out through Flung.
createdAtstringyes
repliedAtstring | nullyes

See also

DocWhy
API referenceEvery endpoint
SchemasEvery request and response type
ErrorsEvery error code and what to do about it