List surveys with filtering
Lists survey responses for the authenticated organization, newest first, using offset pagination.
/api/surveysLists survey responses for the authenticated organization, newest first, using offset pagination. limit defaults to 20 and offset to 0. operatorId filters surveys by the operator assigned to each conversation. Soft-deleted responses remain stored but are excluded from the active collection.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
surveys: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
Maximum number of resources to return.
1 <= value <= 10020One-based page number.
1 <= value <= 9007199254740991Zero-based number of resources to skip.
0 <= value <= 90071992547409910Query parameter. Unique identifier of the related operator.
^([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)$uuidHeader Parameters
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": "11111111-1111-4111-8111-111111111111", "orgId": "55555555-5555-4555-8555-555555555555", "projectId": "11111111-1111-4111-8111-111111111111", "conversationId": "22222222-2222-4222-8222-222222222222", "visitorId": "33333333-3333-4333-8333-333333333333", "rating": 3, "comment": "Very helpful support.", "createdAt": "2030-06-15T09:15:00.000Z" } ], "pagination": { "totalItems": 1, "page": 1, "pageSize": 20, "hasNextPage": false, "hasPrevPage": false }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/surveys' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/surveys", {
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?