List Inbox items
Returns the normalized Inbox contract for Instagram, Facebook, Threads, and X. X replies use source x_reply; legacy X direct messages use x_dm.
Authorization
AuthorizationBearer <token>In header
Workspace API key. Inbox requires the Basic plan or higher.
Query Params
sourceOptionalstring
Filter by ig_comment, ig_dm, threads_reply, fb_comment, fb_dm, x_reply, or x_dm.
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
Message or reply text. Keep private DM content out of logs and analytics.
data[].urlOptionalstring
X permalink when the source exposes one.
data[].x_credits_countedOptionalinteger
Managed-X weighted units attached to this item; workspace_x_app activity reports no UniPost charge.
data[].x_credit_billing_modeOptionalstring
unipost_managed_app or workspace_x_app.
402
error.codestring
UNAUTHORIZED or PLAN_FEATURE_NOT_AVAILABLE.
request_idstring
Request identifier for support.