List conversations

Get a paginated list of conversations for your organization.

Get a paginated list of conversations for your organization. Optionally filter by social account, network, or status. Results are sorted by most recently active first.

GET/v1/conversations

Query Parameters

social_account_id?string

Filter by Social account ID

network?string

Filter by network

status?string
cursor?string

Cursor for pagination (numeric ID of last item)

limit?integer
Default25
Range1 <= value <= 100

Response Body

fetch("https://api.outstand.so/v1/conversations?social_account_id=string&network=instagram&status=active&cursor=string&limit=25", {  method: "GET"})
{
  "success": true,
  "data": [
    {
      "id": "9dyJS",
      "orgId": "string",
      "socialAccountId": "string",
      "network": "instagram",
      "platformConversationId": "string",
      "participantId": "string",
      "participantDisplayName": "string",
      "participantProfilePicture": "string",
      "lastMessageAt": "2019-08-24T14:15:22Z",
      "lastInboundAt": "2019-08-24T14:15:22Z",
      "unreadCount": 0,
      "status": "active",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": 0,
    "limit": 0
  }
}
{
  "success": false,
  "error": "Conversation not found"
}
{
  "success": false,
  "error": "Internal server error"
}