Get all conversations.
cURL
curl --request GET \ --url https://api-staging.respondent.io/v1/messaging/conversations \ --header 'x-api-key: <x-api-key>' \ --header 'x-api-secret: <x-api-secret>'
{ "totalResults": 123, "page": 1, "pageSize": 50, "results": [ { "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 } ] }
Filter conversations by externalResearcherId.
Filter conversations by projectId.
Show child attributes
The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.
includeCount
true