List Inbox items
Returns the normalized Inbox contract for Instagram, Facebook, Threads, and X. X public replies use source x_reply.
Authorization
AuthorizationBearer <token>In header
Workspace API key kept server-side. Inbox requires the Basic plan or higher.
Query Params
inbox_scopestring
Required for API-key requests. Use managed_user for one app user or workspace with a creator-bound owner/admin key.
external_user_idOptionalstring
Required only for managed_user. Derive it from the authenticated app user on your server.
sourceOptionalstring
Filter by ig_comment, ig_dm, threads_reply, fb_comment, fb_dm, x_reply.
is_readOptionalboolean
Return only read or unread items.
is_ownOptionalboolean
Return outbound items when true or inbound items when false.
limitOptionalDefault: 50integer
Number of items, from 1 through 500.
Response Body
200
data[]array
Items ordered by received_at descending.
data[].idstring
UniPost Inbox item ID used by the reply endpoint.
data[].sourcestring
Normalized Inbox source.
data[].thread_keystring
Stable conversation or reply-tree grouping key.
data[].parent_external_idOptionalstring
Parent post, reply, conversation, or participant identifier.
data[].bodyOptionalstring
Comment or reply text.
data[].urlOptionalstring
X permalink when the source exposes one.
400
error.codestring
INBOX_SCOPE_REQUIRED, INBOX_SCOPE_INVALID, MANAGED_USER_NOT_FOUND, INSUFFICIENT_ROLE, API_KEY_CREATOR_REQUIRED, UNAUTHORIZED, or PLAN_FEATURE_NOT_AVAILABLE.
request_idstring
Request identifier for support.
403
error.codestring
INBOX_SCOPE_REQUIRED, INBOX_SCOPE_INVALID, MANAGED_USER_NOT_FOUND, INSUFFICIENT_ROLE, API_KEY_CREATOR_REQUIRED, UNAUTHORIZED, or PLAN_FEATURE_NOT_AVAILABLE.
request_idstring
Request identifier for support.
404
error.codestring
INBOX_SCOPE_REQUIRED, INBOX_SCOPE_INVALID, MANAGED_USER_NOT_FOUND, INSUFFICIENT_ROLE, API_KEY_CREATOR_REQUIRED, UNAUTHORIZED, or PLAN_FEATURE_NOT_AVAILABLE.
request_idstring
Request identifier for support.
402
error.codestring
INBOX_SCOPE_REQUIRED, INBOX_SCOPE_INVALID, MANAGED_USER_NOT_FOUND, INSUFFICIENT_ROLE, API_KEY_CREATOR_REQUIRED, UNAUTHORIZED, or PLAN_FEATURE_NOT_AVAILABLE.
request_idstring
Request identifier for support.