GET
/
v1
/
messaging
/
conversations
/
{conversationUid}
Retrieve specific conversation
curl --request GET \
  --url https://api-staging.respondent.io/v1/messaging/conversations/{conversationUid} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "uid": "<string>",
  "name": "<string>",
  "deleted": true,
  "locked": true,
  "read": true,
  "metadata": {
    "projectId": "<string>",
    "surveyResponseId": "<string>",
    "externalResearcherId": "<string>",
    "externalTeamId": "<string>",
    "externalCompanyId": "<string>"
  },
  "user": {
    "uid": "<string>",
    "foreignId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "participants": [
    {
      "uid": "<string>",
      "foreignId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "read": true,
      "deleted": true
    }
  ],
  "messages": [
    {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "uid": "<string>",
      "body": "<string>",
      "sender": {
        "uid": "<string>",
        "foreignId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "latestMessage": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "uid": "<string>",
    "body": "<string>"
  },
  "messagesCount": 123
}

Headers

x-api-key
string
required
x-api-secret
string
required

Path Parameters

conversationUid
string
required

Response

200 - application/json

The response is of type object.