Skip to navigation

Find responses

Returns a page of responses matching the criteria, such as an attribute value. Use it to find responses for data erasure requests. To find responses to enrich, poll List responses instead, because a response found here may not be fully processed yet.

Authentication

AuthorizationBearer

Your Chattermill API key, from Settings > API in the Chattermill app.

Path parameters

projectstringRequired

Your project’s key, from List projects.

Query parameters

pageintegerOptional
Page number, starting at 1.
per_pageintegerOptional
Results per page. Defaults to 20.

Request

Response search object
idintegerOptional
theme_idintegerOptional
custom_segment_idintegerOptional
search_querystringOptional
user_metaobjectOptional
tag_idintegerOptional

Response

Response model collection
metaobjectOptional
responseslist of objectsOptional

Errors

401
Unauthorized Error