Skip to navigation

List responses

Returns a page of responses that match the filters. To fetch only new feedback, filter by a date range or keep track of the last id you processed.

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.
fromstringOptional

Return responses created at or after this time, in ISO 8601, such as 2026-11-01 or 2026-11-01T09:00:00Z.

updated_fromstringOptional
Return responses last updated at or after this time, in ISO 8601.
updated_tostringOptional

Return responses last updated at or before this time, in ISO 8601. Only applies with updated_from, and defaults to now.

tostringOptional

Return responses created at or before this time, in ISO 8601. Only applies with from, and defaults to now.

data_typestringOptional

Return only responses with this data type key, from List data types.

theme_idintegerOptional
Return only responses that mention this theme, by ID from List themes.
data_sourcestringOptional

Return only responses with this data source key, from List data sources.

filter_propertystringOptional

Attribute key to filter by. Use it with filter_value.

filter_valuestringOptional

Value of filter_property to filter by.

text_analytics_processedbooleanOptional

Set to true to return only responses Chattermill has finished analysing. By default you get both analysed and unanalysed responses.

comment_presentbooleanOptional

Set to true to return only responses with a comment.

score_fromintegerOptional
Lowest score to return.
score_tointegerOptional
Highest score to return.
custom_segment_idintegerOptional
Return only responses in this custom segment, by ID from List custom segments.
search_querystringOptional
Return only responses that match this text search.
tag_idintegerOptional
Return only responses with this tag, by ID from List tags.

Response

Response response collection
metaobjectOptional
responseslist of objectsOptional

Errors

401
Unauthorized Error