Get a public Scope Refinement survey by unique code

GET

/surveys/{code}

const url = 'https://example.com/api/surveys/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/surveys/example

Public: anyone with the unique-code URL can view the survey. Returns only the public shape (code, title, intro, questions) — never id or created_by.

Parameters

Path Parameters

code

required

string

>= 1 characters <= 64 characters

Responses

200

Public survey

application/json

object

survey

required

object

code

required

string

title

required

string

intro

string | null

questions

required

Array<object>

object

Generated server-side (q1..qN) when absent on create.

string

<= 64 characters

title

required

string

>= 1 characters <= 500 characters

description

string

<= 2000 characters

options

required

Array<object>

>= 2 items

object

key

required

string

>= 1 characters <= 8 characters

Example

label

required

string

>= 1 characters <= 500 characters

proposal

Option key the survey author proposes as the default direction.

string

<= 8 characters

404

Not found

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number