Retrieve specific message

GET

messaging

messages

{messageUid}

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>",
  "uid": "<string>",
  "body": "<string>",
  "conversation": {
    "createdAt": "<string>",
    "uid": "<string>",
    "name": "<string>",
    "deleted": true,
    "locked": true,
    "read": true,
    "participants": [
      {
        "uid": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "read": true,
        "deleted": true,
        "foreignId": "<string>"
      }
    ],
    "updatedAt": "<string>",
    "metadata": {
      "projectId": "<string>",
      "surveyResponseId": "<string>",
      "externalResearcherId": "<string>",
      "externalTeamId": "<string>",
      "externalCompanyId": "<string>"
    }
  },
  "sender": {
    "uid": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "foreignId": "<string>"
  },
  "updatedAt": "<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.

Show child attributes

conversation.createdAt

string

required

conversation.uid

string

required

Unique identifier of conversation.

conversation.name

string

required

Name of conversation.

conversation.deleted

boolean

required

If conversation is marked as deleted.

conversation.locked

boolean

required

If conversation is locked.

conversation.read

boolean

required

deprecated

conversation.participants

object[]

required

All participants of conversation including the researcher. The researcher will be the API owner/admin account for the api team.

Show child attributes

conversation.participants.uid

string

required

Unique identifier for messaging user.

conversation.participants.firstName

string

required

First name of user.

conversation.participants.lastName

string

required

Last name initial of user.

conversation.participants.read

boolean

required

Whether the participant has read the conversation.

conversation.participants.deleted

boolean

required

Whether the participant has muted the conversation.

conversation.participants.foreignId

string

UserId of messaging user.

conversation.updatedAt

string

conversation.metadata

object

Metadata of conversation.

Show child attributes

conversation.metadata.projectId

string<ObjectId>

ProjectId of the project the coversation belongs to.

conversation.metadata.surveyResponseId

string<ObjectId>

ScreenerResponseId for the project, if exists.

conversation.metadata.externalResearcherId

string

ExternalResearcherId for the project, if exists.

conversation.metadata.externalTeamId

string

ExternalTeamId for the project, if exists.

conversation.metadata.externalCompanyId

string

ExternalCompanyId for the project, if exists.

sender

object

required

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

Show child attributes

sender.uid

string

required

Unique identifier for messaging user.

sender.firstName

string

required

First name of user.

sender.lastName

string

required

Last name initial of user.

sender.foreignId

string

UserId of messaging user.

updatedAt

string

Retrieve all conversationsGet all conversations.

⌘I

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>",
  "uid": "<string>",
  "body": "<string>",
  "conversation": {
    "createdAt": "<string>",
    "uid": "<string>",
    "name": "<string>",
    "deleted": true,
    "locked": true,
    "read": true,
    "participants": [
      {
        "uid": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "read": true,
        "deleted": true,
        "foreignId": "<string>"
      }
    ],
    "updatedAt": "<string>",
    "metadata": {
      "projectId": "<string>",
      "surveyResponseId": "<string>",
      "externalResearcherId": "<string>",
      "externalTeamId": "<string>",
      "externalCompanyId": "<string>"
    }
  },
  "sender": {
    "uid": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "foreignId": "<string>"
  },
  "updatedAt": "<string>"
}

Getting started

Project Setup

Screener Response Handling

Messaging

Lookup and Reference Data

Webhooks

Team Tools

Headers

Path Parameters

Response