Retrieve all conversations
List all conversations for your organization, with optional filters by project or participant.
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>'{
"page": 1,
"pageSize": 50,
"results": [
{
"createdAt": "<string>",
"uid": "<string>",
"name": "<string>",
"deleted": true,
"locked": true,
"read": true,
"user": {
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"foreignId": "<string>"
},
"participants": [
{
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"read": true,
"deleted": true,
"foreignId": "<string>"
}
],
"messages": [
{
"createdAt": "<string>",
"uid": "<string>",
"body": "<string>",
"sender": {
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"foreignId": "<string>"
},
"updatedAt": "<string>"
}
],
"latestMessage": {
"createdAt": "<string>",
"uid": "<string>",
"body": "<string>",
"updatedAt": "<string>"
},
"messagesCount": 123,
"updatedAt": "<string>",
"metadata": {
"projectId": "<string>",
"surveyResponseId": "<string>",
"externalResearcherId": "<string>",
"externalTeamId": "<string>",
"externalCompanyId": "<string>"
}
}
],
"totalResults": 123
}Query Parameters
Filter conversations by externalResearcherId.
Filter conversations by projectId.
Response
Hide child attributes
Hide child attributes
Unique identifier of conversation.
Name of conversation.
If conversation is marked as deleted.
If conversation is locked.
User who created the conversation. This will be the API owner/admin account for the api team. First name and last name will belong to api team user, not external researcher name. External researcherId will be stored in metadata, which can be used to lookup your external researcher's info internally.
All participants of conversation including the researcher. The researcher will be the API owner/admin account for the api team.
Hide child attributes
Hide child attributes
Unique identifier for messaging user.
First name of user.
Last name initial of user.
Whether the participant has read the conversation.
Whether the participant has muted the conversation.
UserId of messaging user.
All messages in conversation.
Hide child attributes
Hide child attributes
Unique identifier of message.
Body of message.
Sender of message.
Hide child attributes
Hide child attributes
Count of messages in conversation.
Metadata of conversation.
Hide child attributes
Hide child attributes
ProjectId of the project the coversation belongs to.
ScreenerResponseId for the project, if exists.
ExternalResearcherId for the project, if exists.
ExternalTeamId for the project, if exists.
ExternalCompanyId for the project, if exists.
The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.
Was this page helpful?
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>'{
"page": 1,
"pageSize": 50,
"results": [
{
"createdAt": "<string>",
"uid": "<string>",
"name": "<string>",
"deleted": true,
"locked": true,
"read": true,
"user": {
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"foreignId": "<string>"
},
"participants": [
{
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"read": true,
"deleted": true,
"foreignId": "<string>"
}
],
"messages": [
{
"createdAt": "<string>",
"uid": "<string>",
"body": "<string>",
"sender": {
"uid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"foreignId": "<string>"
},
"updatedAt": "<string>"
}
],
"latestMessage": {
"createdAt": "<string>",
"uid": "<string>",
"body": "<string>",
"updatedAt": "<string>"
},
"messagesCount": 123,
"updatedAt": "<string>",
"metadata": {
"projectId": "<string>",
"surveyResponseId": "<string>",
"externalResearcherId": "<string>",
"externalTeamId": "<string>",
"externalCompanyId": "<string>"
}
}
],
"totalResults": 123
}