Messages
List Conversations
Lists the account's direct message conversations, most recent first. Supported on Bluesky, Instagram and Facebook.
GET
Bearerheader
AuthorizationBearer <op_>Workspace API key, sent as Authorization: Bearer op_... Keys are created in the dashboard.
id*stringLength
1 <= lengthlimit?integerItems per page. Defaults to 50. Maximum 100.
Range
1 <= value <= 100Default
50cursor?stringThe nextCursor of the previous page. Omit it for the first page.
Length
1 <= lengthConversations
application/json- response
data*array<>nextCursor*|Cursor for the next page, or null on the last page.
hasMore*booleanTrue when another page follows this one.
Example Request
import { Configuration, InboxApi } from "@onepostly/sdk";const inboxApi = new InboxApi( new Configuration({ accessToken: process.env.ONEPOSTLY_API_KEY }));const response = await inboxApi.listConversations({ id: "acc_YOUR_INSTAGRAM_ACCOUNT_ID",});console.log(response);Example Response
{ "data": [ { "id": "cnv_u1rTltEvz7pEbzpQOLjQAlMVsqWCdakS9U2wjAFB6CV6SYgY3Bx8GTrVhAn9njOg3eB2YWHX", "accountId": "acc_YOUR_INSTAGRAM_ACCOUNT_ID", "members": [ { "id": "17841401234567890", "username": "yourbrand", "displayName": "yourbrand" }, { "id": "6873452198765432", "username": "jane_doe", "displayName": "jane_doe" } ], "muted": false, "unreadCount": 0, "lastMessage": { "id": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDAxMjM0NTY3ODk6MzQwMjgyMzY2ODQxNzEwMzAwOTQ5MTI4MTM2NDEyOTg3NjU0MzIxMDk4NzY1NDMy", "text": "Do you ship to Canada?", "sentAt": "2027-03-15T11:42:08.000Z" } }, { "id": "cnv_UYeVH71CtvWwPasNAhEA9WXmVPAMJhQLmnGMapF5MxmPu59aNUBxoHt0T0YnAq98AujCL19c", "accountId": "acc_YOUR_INSTAGRAM_ACCOUNT_ID", "members": [ { "id": "17841401234567890", "username": "yourbrand", "displayName": "yourbrand" }, { "id": "7120984456321987", "username": "mark.builds", "displayName": "mark.builds" } ], "muted": false, "unreadCount": 0, "lastMessage": { "id": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDAxMjM0NTY3ODk6MzQwMjgyMzY2ODQxNzEwMzAwOTQ5MTI4MTM1MzQ1Njc4OTAxMjM0NTY3ODkwMTIz", "text": "Thanks, it arrived today!", "sentAt": "2027-03-15T10:17:45.000Z" } } ], "nextCursor": null, "hasMore": false}