Inbox summary

GET

/inbox/summary

curl --request GET \
  --url https://postflow.biz.id/api/v1/inbox/summary \
  --header 'Authorization: Bearer <token>'

Open comment and message counts, and each inbox account’s sync state.

Authorizations

• apiKey
• oauth

Responses

200

OK

Media typeapplication/json

object

open

required

Comments waiting for an answer.

integer

openMessages

required

Conversations waiting for an answer.

integer

accounts

required

Array<object>

object

id

required

string

platform

required

string

Allowed values: facebook instagram tiktok threads bluesky youtube telegram

name

required

string

username

required

Any of:

string

string

null

null

avatarUrl

required

Any of:

string

string

null

null

error

required

Any of:

string

string

null

null

lastSyncedAt

required

Any of:

string

string format: date-time

null

null

messaging

required

ok = can read and answer DMs.

string

Allowed values: ok missing_permission unsupported

Example

{
  "accounts": [
    {
      "platform": "facebook",
      "messaging": "ok"
    }
  ]
}

401

Missing, invalid, expired or deleted key or token.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

429

More than 120 requests in a minute with this key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}