Conversations

List DM conversations

Returns a paginated list of direct message conversations from the workspace's connected Instagram and Facebook accounts, newest first (by last message).

Conversations that only contain story mentions are left out. Use needsReply=true to get the conversations waiting on an answer.

Subscription

This endpoint requires the workspace owner to have an active Growth, Premium, or Scale subscription.

get/conversations

Request

  • Base URL: https://api.postplanify.com/api/v1
  • URL: https://api.postplanify.com/api/v1/conversations
  • Auth: HTTP bearer

Query parameters

workspaceIdstring uuid required

Workspace to list conversations from.

needsReplyboolean

If true, only return conversations where the customer is waiting on a reply.

unreadOnlyboolean

If true, only return conversations not yet marked as read.

socialAccountIdstring uuid

Filter by a specific Instagram or Facebook account.

assignedToUserIdstring uuid

Only return conversations assigned to this user. GET /me returns your own ID.

searchstring

Search by customer name, username or message text. Only the first 200 characters are used.

pageinteger
limitinteger

Response

Paginated list of conversations

okboolean

Example response

{
  "ok": true,
  "data": [
    {
      "id": "120a669a-6324-44fd-beed-c9425f199db5",
      "workspaceId": "d35f525f-63e6-40ae-8946-8c120edb0225",
      "participant": {
        "id": "7012345678901234",
        "name": "Sarah Kim",
        "username": "sarah.kim"
      },
      "lastMessagePreview": "Is the holiday blend still available?",
      "messageCount": 3,
      "replyWindow": {
        "canReply": true
      },
      "label": {
        "name": "Lead",
        "color": "green"
      }
    }
  ]
}

Changes

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