Skip to content
Convor
Convor Docs
API ReferenceSurveys

List CSAT responses with filtering

Lists CSAT responses for the current organization, sorted newest first.

GET/api/csat/responses

Lists CSAT responses for the current organization, sorted newest first. Use optional filters for rating, operatorId, and createdAt range. Pagination uses offset and limit; limit defaults to 20, offset defaults to 0, and limit cannot exceed 100.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
csat:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

projectId?string

Query parameter. Unique identifier of the related project.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"
limit?integer

Query parameter. Maximum number of records to return.

Range1 <= value <= 100
Default20
offset?integer

Query parameter. Zero-based number of matching records to skip.

Range0 <= value <= 9007199254740991
Default0
from?string

Query parameter. Value of from.

to?string

Query parameter. Value of to.

operatorId?string

Query parameter. Unique identifier of the related operator.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
rating?integer

Query parameter. Value of rating.

Range1 <= value <= 10
search?string

Query parameter. Search text.

Lengthlength <= 500
sortBy?string

Query parameter. Sort by. Allowed values: rating, createdAt, operator, comment.

Default"createdAt"

Value in

  • "rating"
  • "createdAt"
  • "operator"
  • "comment"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"
format?string

Query parameter. Format. Allowed values: json, csv.

Default"json"

Value in

  • "json"
  • "csv"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "55555555-5555-4555-8555-555555555555",      "projectId": "11111111-1111-4111-8111-111111111111",      "projectName": "Example name",      "conversationId": "11111111-1111-4111-8111-111111111111",      "visitorId": "44444444-4444-4444-8444-444444444444",      "operatorId": "66666666-6666-4666-8666-666666666666",      "rating": 5,      "comment": "Great service!",      "locale": "en",      "createdAt": "2026-06-23T08:00:00.000Z"    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/csat/responses?format=json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/csat/responses?format=json", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Get localized CSAT configuration

Returns the CSAT survey configuration for the selected project.

List surveys with filtering

Lists survey responses for the authenticated organization, newest first, using offset pagination.

On this page

Request examplescurlJavaScript