Docs
Surveys

Get a survey

GET/surveys/{id}Needscontent.view

The survey's working draft — every field — and what each environment serves.

Authorization

secretKey
headerAuthorizationBearer <sk_…>

A secret API key from Settings → API keys. It acts with its creator's role.

Path Parameters

id*integer

The survey's id.

Range1 <= value

Response Body

OK

application/json
  1. response
survey*

A survey with its working draft. What visitors see is the version in publication.

Shell
curl -X GET 'https://app.cueston.com/api/surveys/1'
Example Response
JSON
{
  "survey": {
    "id": 42,
    "name": "Onboarding tour",
    "urlPattern": "https://app.acme.com/*",
    "isActive": true,
    "display": "slideout",
    "position": "bottom-right",
    "questions": [
      {
        "id": "string",
        "type": "nps",
        "prompt": "string",
        "required": false,
        "options": [
          "string"
        ],
        "scaleLabels": {
          "low": "string",
          "high": "string"
        },
        "placeholder": "string",
        "followUp": {
          "whenScoreBelow": -9007199254740991,
          "questionId": "string"
        }
      }
    ],
    "thankYou": "string",
    "localizations": {
      "property1": {
        "thankYou": "string",
        "questions": {
          "property1": {
            "prompt": "string",
            "options": [
              "string"
            ],
            "scaleLabels": {
              "low": "string",
              "high": "string"
            },
            "placeholder": "string"
          },
          "property2": {
            "prompt": "string",
            "options": [
              "string"
            ],
            "scaleLabels": {
              "low": "string",
              "high": "string"
            },
            "placeholder": "string"
          }
        }
      },
      "property2": {
        "thankYou": "string",
        "questions": {
          "property1": {
            "prompt": "string",
            "options": [
              "string"
            ],
            "scaleLabels": {
              "low": "string",
              "high": "string"
            },
            "placeholder": "string"
          },
          "property2": {
            "prompt": "string",
            "options": [
              "string"
            ],
            "scaleLabels": {
              "low": "string",
              "high": "string"
            },
            "placeholder": "string"
          }
        }
      }
    },
    "styling": {
      "accentColor": "string",
      "backgroundColor": "string",
      "textColor": "string",
      "borderRadius": 0
    },
    "delayMs": 0,
    "frequencyType": "once",
    "frequencyDays": 1,
    "audienceRules": {
      "enabled": false,
      "matchType": "all",
      "rules": [
        {
          "id": "string",
          "attribute": "string",
          "operator": "equals",
          "value": "string",
          "key": "string"
        }
      ]
    },
    "priority": 0,
    "createdAt": "2026-10-26T09:30:00Z",
    "updatedAt": "2026-10-26T09:30:00Z",
    "publication": {
      "production": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      },
      "staging": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      }
    },
    "hasUnpublishedChanges": true
  }
}

Create a surveyPOST

Creates a draft survey. Nothing is shown to visitors until you publish it (or send `isActive: true`).

Update a surveyPATCH

Saves changes to the working draft. Fields you leave out keep their value; `null` clears a nullable field. If it's live, visitors keep seeing the published version until you publish again. `PUT` is accepted as an alias.