Surveys

Surveys, responses and answers (PII-free).

List published surveys whose owner node is in the key's subtree

get

Requires surveys:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Query parameters

cursorstringOptional

Opaque pagination cursor from a prior response's next_cursor.

limitinteger · min: 1 · max: 100OptionalDefault: 25

Responses

200

A page of surveys.

application/json

next_cursorstring · nullableRequired

Pass as ?cursor= to fetch the next page; null on the last page.

has_morebooleanRequired

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

get/surveys

HTTPcURLJavaScriptPython

GET /api/v4/surveys HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "node_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "published",
      "primary_language": "en",
      "published_at": null,
      "created_at": "2026-08-11T20:23:01.489Z"
    }
  ],
  "next_cursor": null,
  "has_more": true
}

Get a single published survey (with its published definition)

get

Requires surveys:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Path parameters

idstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

node_idstring · uuidOptional

statusstringOptionalExample: published

primary_languagestringOptionalExample: en

published_atstring · nullableOptional

created_atstring · date-timeOptional

published_definitionobjectOptional

The published survey definition (pages/questions).

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

404

Not found or outside the key's scope.

application/json

get/surveys/{id}

HTTPcURLJavaScriptPython

GET /api/v4/surveys/{id} HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "node_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "published",
  "primary_language": "en",
  "published_at": null,
  "created_at": "2026-08-11T20:23:01.489Z",
  "published_definition": {}
}

List responses for a survey (newest first)

get

Requires surveys:read. Respondent PII is not included.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Path parameters

idstring · uuidRequired

Query parameters

cursorstringOptional

Opaque pagination cursor from a prior response's next_cursor.

limitinteger · min: 1 · max: 100OptionalDefault: 25

Responses

200

A page of responses.

application/json

next_cursorstring · nullableRequired

Pass as ?cursor= to fetch the next page; null on the last page.

has_morebooleanRequired

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

404

Not found or outside the key's scope.

application/json

get/surveys/{id}/responses

HTTPcURLJavaScriptPython

GET /api/v4/surveys/{id}/responses HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "survey_id": "123e4567-e89b-12d3-a456-426614174000",
      "node_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "completed",
      "channel": "email",
      "overall_score": null,
      "started_at": "2026-08-11T20:23:01.489Z",
      "completed_at": null,
      "created_at": "2026-08-11T20:23:01.489Z"
    }
  ],
  "next_cursor": null,
  "has_more": true
}

List the answers for a single response

get

Requires surveys:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Path parameters

idstring · uuidRequired

responseIdstring · uuidRequired

Responses

200

OK

application/json

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

404

Not found or outside the key's scope.

application/json

get/surveys/{id}/responses/{responseId}/answers

HTTPcURLJavaScriptPython

GET /api/v4/surveys/{id}/responses/{responseId}/answers HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "question_id": "text",
      "question_path": "text",
      "question_type": "rating",
      "value": null,
      "numeric_value": null,
      "comment": null,
      "answered_at": "2026-08-11T20:23:01.489Z"
    }
  ]
}