Quizzes

Quiz endpoints sit under /api/brands/{brand}/quizzes/ with moduleAccess:quizzes middleware. Authenticate with EF-Access-Key.

List Quizzes

GET /api/brands/{brand}/quizzes

number

Results per page (1–100, default: 25)

string

Search by name

string

newest, oldest, created_at, updated_at

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes \
  -H "EF-Access-Key: your_api_key_here"

{
  "current_page": 1,
  "data": [
    {
      "id": 4,
      "code": "health-quiz-xyz",
      "name": "Health Assessment Quiz",
      "page_id": 201,
      "total_entries": 312,
      "updated_at": "2024-12-10T15:00:00.000000Z"
    }
  ],
  "per_page": 25,
  "total": 4,
  "last_page": 1
}

List Quizzes (Unpaginated)

GET /api/brands/{brand}/quizzes/all

Returns { id, name, code } for all quizzes — useful for dropdowns and mapping.

Get Quiz

GET /api/brands/{brand}/quizzes/{quiz}

{
  "id": 4,
  "code": "health-quiz-xyz",
  "name": "Health Assessment Quiz",
  "page_id": 201,
  "page": { "id": 201, "title": "Health Quiz Page", "slug": "health-quiz" },
  "total_entries": 312,
  "config": { /* quiz theme/layout config */ },
  "fields": [
    { "id": 10, "code": "screen-abc", "name": "Question 1", "type": "single_choice", "order": 0 }
  ],
  "slug": "health-quiz",
  "domain": { "domain": "quiz.mybrand.com" }
}

flow_data is not included in the show response. Use GET .../flow to retrieve the flow graph.

Create Quiz

POST /api/brands/{brand}/quizzes

string

required

Quiz name

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name": "Health Assessment Quiz"}'

{
  "quiz": {
    "id": 4,
    "code": "health-quiz-xyz",
    "name": "Health Assessment Quiz",
    "page_id": 201,
    "total_entries": 0
  }
}

{
  "error": "Plan limit exceeded",
  "plan_error": {
    "type": "plan_upgrade_required",
    "feature": "quizzes",
    "message": "Your plan does not allow creating more quizzes.",
    "plan_name": "Starter",
    "upgrade_info": {}
  },
  "errors": { /* field errors */ }
}

Update Quiz

PUT /api/brands/{brand}/quizzes/{quiz}

string

required

Quiz name (max 255)

number

ID of the page to associate with this quiz

object

Quiz display configuration (theme, layout, computed variables, etc.)

{
  "id": 4,
  "code": "health-quiz-xyz",
  "name": "Health Assessment Quiz",
  "config": { /* updated config */ }
}

{
  "message": "Validation failed.",
  "errors": {
    "name": ["The name field is required."]
  },
  "component_errors": []
}

Delete Quiz

DELETE /api/brands/{brand}/quizzes/{quiz}

{ "success": true }

Get Quiz Flow

Returns the visual flow graph (Drawflow format) and all screen definitions.

GET /api/brands/{brand}/quizzes/{quiz}/flow

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes/4/flow \
  -H "EF-Access-Key: your_api_key_here"

{
  "flow": {
    "drawflow": {
      "Home": {
        "data": {
          "1": { "id": 1, "name": "Question 1", "inputs": {}, "outputs": {} },
          "2": { "id": 2, "name": "Result Screen", "inputs": {}, "outputs": {} }
        }
      }
    }
  },
  "screens": [
    {
      "id": 10,
      "code": "screen-abc",
      "name": "Question 1",
      "type": "single_choice",
      "order": 0
    }
  ]
}

If no flow has been saved yet, flow defaults to a minimal empty Drawflow structure ({"drawflow":{"Home":{"data":[]}}}).

Save Quiz Flow

POST /api/brands/{brand}/quizzes/{quiz}/flow

any

The complete Drawflow graph object. Can be null to clear the flow.

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes/4/flow \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"flow": { /* drawflow object */ }}'

{
  "success": true,
  "message": "Flow saved successfully"
}

Screens

Quiz screens are the individual question/result pages within a quiz. They are nested under the quiz resource.

List Screens

GET /api/brands/{brand}/quizzes/{quiz}/screens

{
  "data": [
    {
      "id": 10,
      "code": "screen-abc",
      "name": "Do you experience bloating?",
      "type": "single_choice",
      "order": 0,
      "options": [
        { "label": "Yes, often", "value": "often" },
        { "label": "Sometimes", "value": "sometimes" },
        { "label": "Never", "value": "never" }
      ],
      "style": "light"
    }
  ]
}

Get Screen

GET /api/brands/{brand}/quizzes/{quiz}/screens/{screen}

Create Screen

POST /api/brands/{brand}/quizzes/{quiz}/screens

string

required

Screen name / question title

string

required

Screen type: single_choice, multiple_choice, text_input, rating, result, info, video, image

string

Display title shown to the user

string

Subtitle or question description

array

Answer options (for choice screens) — each with label and value

object

Additional screen-level configuration

string

HTML content (for info and result screens)

string

light or dark

number

Display order. Auto-incremented if omitted.

file

Audio file upload (multipart)

file

Image file upload (multipart)

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes/4/screens \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bloating Question",
    "type": "single_choice",
    "title": "Do you experience bloating after meals?",
    "style": "light",
    "options": [
      {"label": "Yes, often", "value": "often"},
      {"label": "Sometimes", "value": "sometimes"},
      {"label": "Never", "value": "never"}
    ]
  }'

{
  "quiz": {
    "id": 10,
    "code": "screen-abc",
    "name": "Bloating Question",
    "type": "single_choice",
    "order": 3
  }
}

The response key is "quiz" even though the value is a screen object. This is a known naming quirk.

Update Screen

PUT /api/brands/{brand}/quizzes/{quiz}/screens/{screen}

Same body as Create.

Delete Screen

DELETE /api/brands/{brand}/quizzes/{quiz}/screens/{screen}

{ "success": true }

Reorder Screens

POST /api/brands/{brand}/quizzes/{quiz}/screens/order

object

required

Map of { "<screenId>": <integer order>, ... }

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/quizzes/4/screens/order \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"order": {"10": 0, "11": 1, "12": 2}}'

{ "success": true }

Duplicate Screen

POST /api/brands/{brand}/quizzes/{quiz}/screens/{screen}/duplicate

Creates an exact copy of the screen with a new code and auto-assigned order.

{ "success": true }

Notes

flow_data is separate from the quiz’s config and screen definitions — save and retrieve it with the dedicated /flow endpoints
Screen code values are auto-generated unique identifiers used in the flow graph to connect questions to answer paths
total_entries tracks submission count and is incremented automatically when entries are submitted via the public form

Getting Started

Endpoints

List Quizzes

List Quizzes (Unpaginated)

Get Quiz

Create Quiz

Update Quiz

Delete Quiz

Get Quiz Flow

Save Quiz Flow

Screens

List Screens

Get Screen

Create Screen

Update Screen

Delete Screen

Reorder Screens

Duplicate Screen

Notes

​List Quizzes

​List Quizzes (Unpaginated)

​Get Quiz

​Create Quiz

​Update Quiz

​Delete Quiz

​Get Quiz Flow

​Save Quiz Flow

​Screens

​List Screens

​Get Screen

​Create Screen

​Update Screen

​Delete Screen

​Reorder Screens

​Duplicate Screen

​Notes

List Quizzes

List Quizzes (Unpaginated)

Get Quiz

Create Quiz

Update Quiz

Delete Quiz

Get Quiz Flow

Save Quiz Flow

Screens

List Screens

Get Screen

Create Screen

Update Screen

Delete Screen

Reorder Screens

Duplicate Screen

Notes