Social Inbox

List inbox conversations

Returns paginated conversations for an account or team inbox.

get/inbox/{inboxId}

Request

  • Base URL: https://socialbu.com/api/v1
  • URL: https://socialbu.com/api/v1/inbox/{inboxId}
  • Auth: HTTP bearer

Path parameters

inboxIdstring required

Inbox identifier, such as a_123 for an account inbox or t_45 for a team inbox.

Query parameters

pageinteger

Page number to return.

per_pageinteger

Number of conversations per page, up to 100.

status'open' | 'pending' | 'closed' | 'spam'

Filter conversations by status.

post_idstring

Filter conversations whose external_id matches this platform post ID.

assigned_tostring

Filter by assignment. Use mine, unassigned, assigned, or a user ID.

startstring date-time

Include conversations updated on or after this date/time.

endstring date-time

Include conversations updated on or before this date/time.

item_typesstring[]

Filter conversations containing one or more inbox item types.

account_types[]string[]

Filter conversations by one or more connected account types, such as facebook.page, instagram.api, or bluesky.profile.

unreadboolean

When true, return only conversations containing qualifying unread inbound items.

qstring

Search contact name, username, or item content.

Response

Conversations retrieved successfully.

currentPageinteger

Current page number.

lastPageinteger

Last available page number.

nextPageinteger nullable

Next page number, or null when this is the last page.

totalinteger

Total number of matching conversations.

Changes

No recorded changes to this operation across all 1 revision of this API.