Get conversation

Get detailed information about a specific conversation, including participant details and unread count.

Get detailed information about a specific conversation, including participant details and unread count.

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/{id}

Path Parameters

id*string

Response Body

Conversation retrieved successfully

application/json
  1. response

Single conversation details

success*boolean
conversation*

A conversation with a participant

Example Request
curl -X GET 'https://api.outstand.so/v1/conversations/string'
Example Response
{  "success": true,  "conversation": {    "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"  }}