Get a survey with all responses (super admin only)

GET

/admin/scope-surveys/{id}

const url = 'https://example.com/api/admin/scope-surveys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/admin/scope-surveys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerApiKey
cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Full survey with responses (newest first)

application/json

object

survey

required

object

required

string format: uuid

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

created_by

string | null format: uuid

created_at

required

string format: date-time

updated_at

required

string format: date-time

responses

required

Array<object>

object

required

string format: uuid

respondent_email

required

string format: email

answers

required

Array<object>

object

question_id

required

string

<= 64 characters

choice

required

Option key of the chosen option.

string

<= 16 characters

note

string

<= 2000 characters

comment

string | null

created_at

required

string format: date-time

401

Not authenticated

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

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

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

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