Skip to main content
GET
/
v1
/
messaging
/
messages
Retrieve all messages
curl --request GET \
  --url https://api-staging.respondent.io/v1/messaging/messages \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "page": 1,
  "pageSize": 50,
  "results": [
    {
      "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>"
    }
  ],
  "totalResults": 123
}

Headers

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

Query Parameters

​
page
number
default:1
​
pageSize
number
default:20
​
includeCount
boolean
default:false
​
conversationUid
string

Filter messages by conversationUid.

​
externalResearcherId
string

Filter messages by externalResearcherId.

​
projectId
string<ObjectId>

Filter messages by projectId.

​
since
string

Get all messages since timestamp.

​
until
string

Get all messages until timestamp.

Response

200 - application/json
​
page
number
default:1
required
​
pageSize
number
default:50
required
​
results
object[]
required
​
totalResults
number

The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.