Skip to main content
GET
/
v1
/
messaging
/
messages
/
inbox
Retrieve unread conversations
curl --request GET \
  --url https://api-staging.respondent.io/v1/messaging/messages/inbox \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "read": true,
  "count": 123,
  "unreadIds": [
    "<string>"
  ],
  "unreadCount": 123
}

Headers

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

Query Parameters

​
externalResearcherId
string

Filter by external researcher id.

​
projectId
string<ObjectId>

Filter by projectId.

Response

200 - application/json
​
read
boolean
required

All conversations in the inbox have been read.

​
count
number
required

Count of conversations user is in.

​
unreadIds
string[]
required

List of unread conversations uids.

​
unreadCount
number
required

Count of unread conversations in the inbox.