Haekka Quizzes API
The Quizzes API from Haekka — 12 operation(s) for quizzes.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/haekka:haekka-quizzes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Snippets Quizzes API
description: Test description
termsOfService: https://www.google.com/policies/terms/
contact:
email: contact@snippets.local
license:
name: BSD License
version: v1
servers:
- url: https://app.haekka.com/
security:
- Bearer: []
tags:
- name: Quizzes
paths:
/api/quizzes/:
parameters: []
get:
operationId: api_quizzes_list
description: ''
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type:
- string
- 'null'
format: uri
previous:
type:
- string
- 'null'
format: uri
results:
type: array
items:
$ref: '#/components/schemas/WeeklyQuiz'
tags:
- Quizzes
summary: Api quizzes list
x-summary-source: derived
post:
operationId: api_quizzes_create
description: ''
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
required: true
summary: Api quizzes create
x-summary-source: derived
/api/quizzes/company:
parameters: []
get:
operationId: api_quizzes_company_list
description: ''
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type:
- string
- 'null'
format: uri
previous:
type:
- string
- 'null'
format: uri
results:
type: array
items:
$ref: '#/components/schemas/CompanyWeeklyQuiz'
tags:
- Quizzes
summary: Api quizzes company list
x-summary-source: derived
post:
operationId: api_quizzes_company_create
description: ''
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
required: true
summary: Api quizzes company create
x-summary-source: derived
/api/quizzes/company/{id}:
parameters:
- name: id
in: path
description: A UUID string identifying this company quiz.
required: true
schema:
type: string
format: uuid
get:
operationId: api_quizzes_company_read
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuiz'
tags:
- Quizzes
summary: Api quizzes company read
x-summary-source: derived
put:
operationId: api_quizzes_company_update
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
required: true
summary: Api quizzes company update
x-summary-source: derived
patch:
operationId: api_quizzes_company_partial_update
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyWeeklyQuizWrite'
required: true
summary: Api quizzes company partial update
x-summary-source: derived
delete:
operationId: api_quizzes_company_delete
description: ''
responses:
'204':
description: ''
tags:
- Quizzes
summary: Api quizzes company delete
x-summary-source: derived
/api/quizzes/company/{id}/schedule/{schedule_id}/evidencereport:
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: schedule_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_company_schedule_evidencereport_list
description: ''
responses:
'200':
description: ''
tags:
- Quizzes
summary: Api quizzes company schedule evidencereport list
x-summary-source: derived
/api/quizzes/company/{id}/schedule/{schedule_id}/overviewreport:
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: schedule_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_company_schedule_overviewreport_list
description: ''
responses:
'200':
description: ''
tags:
- Quizzes
summary: Api quizzes company schedule overviewreport list
x-summary-source: derived
/api/quizzes/company/{id}/schedule/{schedule_id}/send_engagement_now:
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: schedule_id
in: path
required: true
schema:
type: string
post:
operationId: api_quizzes_company_schedule_send_engagement_now_create
description: ''
responses:
'201':
description: ''
tags:
- Quizzes
summary: Api quizzes company schedule send engagement now create
x-summary-source: derived
/api/quizzes/{company_engagement_id}/check_dynamic_distribution:
parameters:
- name: company_engagement_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_check_dynamic_distribution_list
description: ''
responses:
'200':
description: ''
tags:
- Quizzes
summary: Api quizzes check dynamic distribution list
x-summary-source: derived
/api/quizzes/{company_engagement_id}/check_engagement_data:
parameters:
- name: company_engagement_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_check_engagement_data_list
description: ''
responses:
'200':
description: ''
tags:
- Quizzes
summary: Api quizzes check engagement data list
x-summary-source: derived
/api/quizzes/{company_engagement_id}/employee/{employee_id}/post_welcome_message:
parameters:
- name: company_engagement_id
in: path
required: true
schema:
type: string
- name: employee_id
in: path
required: true
schema:
type: string
post:
operationId: api_quizzes_employee_post_welcome_message_create
description: ''
responses:
'201':
description: ''
tags:
- Quizzes
summary: Api quizzes employee post welcome message create
x-summary-source: derived
/api/quizzes/{company_engagement_id}/schedules:
parameters:
- name: company_engagement_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_schedules_list
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EngagementSchedules'
tags:
- Quizzes
summary: Api quizzes schedules list
x-summary-source: derived
/api/quizzes/{company_quiz_id}/question_statistics:
parameters:
- name: company_quiz_id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_question_statistics_list
description: ''
responses:
'200':
description: ''
tags:
- Quizzes
summary: Api quizzes question statistics list
x-summary-source: derived
/api/quizzes/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
operationId: api_quizzes_read
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuiz'
tags:
- Quizzes
summary: Api quizzes read
x-summary-source: derived
put:
operationId: api_quizzes_update
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
required: true
summary: Api quizzes update
x-summary-source: derived
patch:
operationId: api_quizzes_partial_update
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
tags:
- Quizzes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WeeklyQuizWrite'
required: true
summary: Api quizzes partial update
x-summary-source: derived
delete:
operationId: api_quizzes_delete
description: ''
responses:
'204':
description: ''
tags:
- Quizzes
summary: Api quizzes delete
x-summary-source: derived
components:
schemas:
QuizQuestion:
type: object
properties:
id:
title: Id
type: string
format: uuid
answers:
type: array
items:
$ref: '#/components/schemas/QuizQuestionAnswer'
editor_content:
$ref: '#/components/schemas/editor_state_in_lesson_serializers'
quiz_question_context:
title: Quiz question context
type: string
readOnly: true
engagement_custom_video:
type: array
items:
$ref: '#/components/schemas/CustomEngagementQuestionVideo'
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
position:
title: Position order
type: integer
maximum: 32767
minimum: -32768
answer_type:
title: Answer type
type:
- string
- 'null'
enum:
- no_action
- user_acknowledged
- multiple_choice
- neutral
- written_response
- external_url
external_url:
title: External URL
type:
- string
- 'null'
format: uri
maxLength: 200
external_url_btn_text:
title: External URL button text
type:
- string
- 'null'
single_select:
title: Single select
type: boolean
quiz:
title: Quiz
type: string
format: uuid
readOnly: true
RichTextEditorState:
type: object
properties:
id:
title: Id
type: string
format: uuid
editor_state:
title: Stringified Editor state
type:
- string
- 'null'
content:
type: array
items:
$ref: '#/components/schemas/ContentImage'
Owner:
required:
- id
- name
type: object
properties:
id:
title: Id
type: string
format: uuid
name:
title: Name
type: string
minLength: 1
lesson_image_in_lesson_serializers:
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
company:
title: Company
type:
- string
- 'null'
format: uuid
image_name:
title: Image Name
type:
- string
- 'null'
maxLength: 200
image_url:
title: Image url
type:
- string
- 'null'
readOnly: true
format: uri
image_url_public:
title: Image url public
type:
- string
- 'null'
readOnly: true
format: uri
editor_content:
title: Editor Content
type:
- string
- 'null'
format: uuid
content_type:
title: Content Type
type:
- string
- 'null'
enum:
- lesson
- quiz
- engagement_question
- engagement_message
- assessment_question_content
EngagementWelcomeMessage:
required:
- editor_content
- engagement
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
editor_content:
$ref: '#/components/schemas/RichTextEditorState'
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
enabled:
title: Enabled
type: boolean
slack_markup:
title: Slack Markup
type:
- string
- 'null'
button_text:
title: Button text
type: string
maxLength: 50
minLength: 1
polymorphic_ctype:
title: Polymorphic ctype
type: integer
readOnly: true
engagement:
title: Engagement
type: string
format: uuid
CustomEngagementQuestionVideo:
required:
- name
- progress
- thumbnail
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
engagement_question:
title: Engagement
type:
- string
- 'null'
format: uuid
service_id:
title: Service ID
type: integer
readOnly: true
name:
title: Video Title
type: string
maxLength: 300
minLength: 1
duration:
title: Duration
type: integer
readOnly: true
hashed_id:
title: Hashed id
type: string
readOnly: true
progress:
title: Progress
type: string
format: decimal
thumbnail:
title: Thumbnail
type: string
maxLength: 500
minLength: 1
processed:
title: Processed
type: boolean
plays:
title: Plays
type: integer
maximum: 2147483647
minimum: -2147483648
ContentImage:
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
company:
title: Company
type:
- string
- 'null'
format: uuid
image_name:
title: Image Name
type:
- string
- 'null'
maxLength: 200
image_url:
title: Image url
type:
- string
- 'null'
readOnly: true
format: uri
image_url_public:
title: Image url public
type:
- string
- 'null'
readOnly: true
format: uri
editor_content:
title: Editor Content
type:
- string
- 'null'
format: uuid
CompanyWeeklyQuiz:
required:
- quiz
- welcome_message
- closing_message
- company
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
quiz:
$ref: '#/components/schemas/WeeklyQuiz'
next_renew_date:
title: Next renew date
type: string
readOnly: true
start_date_for_dynamic_engagement:
title: Start date for dynamic engagement
type: string
readOnly: true
owners:
type: array
items:
$ref: '#/components/schemas/Owner'
welcome_message:
$ref: '#/components/schemas/EngagementWelcomeMessage'
closing_message:
$ref: '#/components/schemas/EngagementClosingMessage'
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
active:
title: Active
type: boolean
start_date:
title: Start date
type:
- string
- 'null'
format: date-time
channels:
type: array
items:
title: Channels
type: string
maxLength: 100
minLength: 1
okta_groups_sync:
type: array
items:
title: Okta groups sync
type: string
maxLength: 200
minLength: 1
auto_enroll:
title: Auto enroll
type: boolean
send_cycle:
title: Send cycle
type: string
enum:
- once
- weekly
- monthly
- quarterly
- semi-annual
- annual
respect_users_tz:
title: Respect users tz
type: boolean
company:
title: Company
type: string
format: uuid
created_by:
title: Created by
type:
- string
- 'null'
format: uuid
WeeklyQuizWrite:
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
title:
title: Title
type:
- string
- 'null'
maxLength: 200
is_technical:
title: Is technical
type: boolean
anonymize_user_results:
title: Anonymize user results
type: boolean
engagement_type:
title: Engagement Type
type: string
enum:
- private
- channel
mention_channel:
title: Mention channel
type: boolean
channel:
title: Channel
type:
- string
- 'null'
maxLength: 20
minLength: 1
company:
title: Company
type:
- string
- 'null'
format: uuid
EngagementSchedules:
required:
- send_time
- company_quiz
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
engagement_title:
title: Engagement title
type: string
readOnly: true
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
send_time:
title: Send time
type: string
format: date-time
is_sent:
title: Is sent
type: boolean
company_quiz:
title: Company quiz
type: string
format: uuid
QuizQuestionAnswer:
required:
- answer
type: object
properties:
id:
title: Id
type: string
format: uuid
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
answer:
title: Answer
description: "You must use the Slack nomenclature for the markdown,\n for more info visit: https://api.slack.com/reference/surfaces/formatting"
type: string
maxLength: 150
minLength: 1
position:
title: Order
type: integer
maximum: 32767
minimum: -32768
correct:
title: Correct
type:
- boolean
- 'null'
explanation:
title: Answer Explanation
description: "You must use the Slack nomenclature for the markdown,\n for more info visit: https://api.slack.com/reference/surfaces/formatting"
type:
- string
- 'null'
question:
title: Question
type: string
format: uuid
readOnly: true
ChannelEngagement:
required:
- message_ts
- channel
- engagement
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
video_ts:
title: Video ts
type:
- string
- 'null'
maxLength: 30
message_ts:
title: Message ts
type: string
maxLength: 30
minLength: 1
channel:
title: Channel
type: string
maxLength: 20
minLength: 1
schedule_id:
title: Schedule id
type: string
maxLength: 50
engagement:
title: Engagement
type: string
format: uuid
CompanyWeeklyQuizWrite:
required:
- quiz
- company
- owners
- welcome_message
- closing_message
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
quiz:
title: Quiz
type: string
format: uuid
company:
title: Company
type: string
format: uuid
created_by:
title: Created by
type:
- string
- 'null'
format: uuid
active:
title: Active
type: boolean
start_date:
title: Start date
type:
- string
- 'null'
format: date-time
channels:
type: array
items:
title: Channels
type: string
maxLength: 100
minLength: 1
okta_groups_sync:
type: array
items:
title: Okta groups sync
type: string
maxLength: 200
minLength: 1
auto_enroll:
title: Auto enroll
type: boolean
send_cycle:
title: Send cycle
type: string
enum:
- once
- weekly
- monthly
- quarterly
- semi-annual
- annual
respect_users_tz:
title: Respect users tz
type: boolean
owners:
type: array
items:
type: string
format: uuid
uniqueItems: true
welcome_message:
$ref: '#/components/schemas/RichTextEditorState'
welcome_message_markup:
title: Welcome message markup
type: string
minLength: 1
welcome_message_enabled:
title: Welcome message enabled
type: boolean
welcome_message_button_text:
title: Welcome message button text
type: string
minLength: 1
closing_message:
$ref: '#/components/schemas/RichTextEditorState'
closing_message_markup:
title: Closing message markup
type: string
minLength: 1
closing_message_enabled:
title: Closing message enabled
type: boolean
review_enabled:
title: Review enabled
type: boolean
editor_state_in_lesson_serializers:
required:
- content
type: object
properties:
id:
title: Id
type: string
format: uuid
note_editor_state:
title: Stringified note Editor's content
type:
- string
- 'null'
summary_editor_state:
title: Stringified summary Editor's content
type:
- string
- 'null'
question_editor_state:
title: Stringified question Editor's content
type:
- string
- 'null'
quiz_editor_state:
title: Stringified quiz Editor's content
type:
- string
- 'null'
quiz_message_state:
title: Stringified quiz message Editor's content
type:
- string
- 'null'
content:
type: array
items:
$ref: '#/components/schemas/lesson_image_in_lesson_serializers'
WeeklyQuiz:
required:
- channel_engagements
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
title:
title: Title
type:
- string
- 'null'
maxLength: 200
company:
title: Company
type:
- string
- 'null'
format: uuid
engagement_type:
title: Engagement Type
type: string
enum:
- private
- channel
mention_channel:
title: Mention channel
type: boolean
channel:
title: Channel
type:
- string
- 'null'
maxLength: 20
minLength: 1
questions:
type: array
items:
$ref: '#/components/schemas/QuizQuestion'
channel_engagements:
type: array
items:
$ref: '#/components/schemas/ChannelEngagement'
anonymize_user_results:
title: Anonymize user results
type: boolean
EngagementClosingMessage:
required:
- editor_content
- engagement
type: object
properties:
id:
title: Id
type: string
format: uuid
readOnly: true
editor_content:
$ref: '#/components/schemas/RichTextEditorState'
created:
title: Created date
type: string
format: date-time
readOnly: true
modified:
title: Modified date
type: string
format: date-time
readOnly: true
enabled:
title: Enabled
type: boolean
slack_markup:
title: Slack Markup
type:
- string
- 'null'
show_review_option:
title: Show review option
type: boolean
polymorphic_ctype:
title: Polymorphic ctype
type: integer
readOnly: true
engagement:
title: Engagement
type: string
format: uuid
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
x-provenance:
method: harvested
publisher: Haekka
source: https://app.haekka.com/swagger.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)