v1Resources/Social Inbox/getList inbox items
List inbox items
Lists Social Inbox comments, direct messages and mentions, newest first, 20 per page. Filters apply before paging, so total counts only the matching items. Every item carries actions, which says what can be done to it through this API and, when something cannot, the reason.
get
inbox:read/api/v1/inboxQuery parameters
kindstring (comment | message | mention)optional
Only this kind of item.
platformstringoptional
A network key, for example instagram.
statusstring (open | resolved)optional
Only open or only resolved items.
clientIdstringoptional
Only this client's items.
keywordstringoptional
Text or @handle to search for.
pageintegeroptional
The page number, from 0.
Response
dataobjectoptional
itemsarray of objectoptional
The items.
totalintegeroptional
How many items match the filters.
pageintegeroptional
This page's number.
pageSizeintegeroptional
How many items a page holds.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/inbox
Your API key
kind
platform
status
clientId
keyword
page
{}