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.

Permissions: Requires conversations:read. Access is limited by the API key creator's current organization membership and stored key ceiling. See Organization permissions.

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
Range1 <= value <= 100
Default25

Response Body

Conversations retrieved successfully

application/json
  1. response

List of conversations

success*boolean
data*array<>
pagination*
Example Request
curl -X GET 'https://api.outstand.so/v1/conversations'
Example Response
{  "success": true,  "data": [    {      "id": "string",      "orgId": "string",      "socialAccountId": "string",      "network": "string",      "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  }}