ConfettiDocs

Get a survey

GET/v1/protected/surveys/{surveyId}

Fetch a single survey's full definition for the team the secret key belongs to: every reachable question with its properties and routing logic (the conditional data). Includes active and inactive surveys and excludes deleted ones. Server-to-server only — authenticate with a secret key sent as Authorization: Bearer cfti_sk_....

Authorization

BearerAuth
AuthorizationBearer <token>

Your team's secret key (cfti_sk_...), sent as a bearer token. Keep it server-side — never expose it in client code.

In: header

Path Parameters

surveyId*string

Response Body

application/json

curl -X GET "https://example.com/v1/protected/surveys/123"
{  "data": {    "id": "string",    "title": "string",    "description": "string",    "status": "active",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "questions": [      {        "id": "string",        "title": "string",        "description": "string",        "position": 0,        "required": true,        "properties": {          "type": "rating",          "buttonLabel": "string",          "shouldAutoProgress": true,          "scale": 0,          "labels": {            "lower": "string",            "upper": "string"          },          "display": "star"        },        "routingLogic": {          "type": "always",          "target": {            "type": "next"          }        }      }    ]  }}

Was this page helpful?