GET
/
v1
/
messaging
/
messages
/
{messageUid}
Retrieve specific message
curl --request GET \
  --url https://api-staging.respondent.io/v1/messaging/messages/{messageUid} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "uid": "<string>",
  "body": "<string>",
  "conversation": {
    "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>"
    },
    "participants": [
      {
        "uid": "<string>",
        "foreignId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "read": true,
        "deleted": true
      }
    ]
  },
  "sender": {
    "uid": "<string>",
    "foreignId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Headers

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

Path Parameters

messageUid
string
required

Response

200 - application/json
createdAt
string
required
uid
string
required

Unique identifier of message.

body
string
required

Body of message.

conversation
object
required

Conversation message belongs to.

sender
object
required

Sender of message. Either a participant or the api team owner/admin. To find the external researcher, use conversation.metadata.externalResearcherId.

updatedAt
string