Skip to content
Pinlyx Docs
Open app

Social inbox summary

GET
/v1/social/inbox/summary

One-call inbox health: conversation and unread totals overall and per network, plus the threads whose last message came from the participant, oldest first. Requires scope social:read.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Inbox summary.

Inbox health in one call.

object
accounts
integer
conversations
integer
activeConversations
integer
archivedConversations
integer
unreadConversations
integer
unreadMessages
integer
lastMessageAt
string format: date-time
nullable
platforms
Array<object>
object
platform
string
conversations
integer
unreadConversations
integer
unreadMessages
integer
lastMessageAt
string format: date-time
nullable
awaitingReply

Up to 10 active threads whose last message came from the participant, longest wait first.

Array<object>
object
conversationId
integer
platform
string
participantName
string
nullable
contactId
integer
nullable
unreadCount
integer
lastMessageAt
string format: date-time
nullable
lastMessagePreview
string
nullable

401

Section titled “401 ”

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

402

Section titled “402 ”

The workspace’s plan does not include this module. The social inbox needs channel_social_inbox and the post scheduler needs marketing_social_scheduler; details.FeatureKey names the one that is missing. Upgrading unlocks it, there is nothing to retry.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "payment_required",
  "message": "your plan does not include this feature; upgrade to unlock it",
  "details": {
    "FeatureKey": "marketing_social_scheduler",
    "UpgradeRequired": true
  }
}

403

Section titled “403 ”

The API key does not have the required scope for this operation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "forbidden",
  "message": "scope contacts:write is required"
}