PulseLMS
API docs by Redocly

Pulse LMS (1.0.0)

Download OpenAPI specification:

Suresh Kumar Mukhiya: itsmeskm99@gmail.com URL: https://pulse-lms.netlify.app/ License: Apache 2.0 Terms of Service

API specification for Pulse LMS..

Find out how to create a GitHub repo for your OpenAPI definition.

Introduction

This API definition is intended to to be a good starting point for describing your API in OpenAPI/Swagger format.

Auth

Authentication and password reset.

Login

Login with email and password.

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "tokens": {
    }
}

Refresh tokens

Exchange a refresh token for new access and refresh tokens.

Request Body schema: application/json
required
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "expiresIn": 0
}

Request password reset

Send a password reset email with a reset link/token.

Request Body schema: application/json
required
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Reset password

Confirm password reset using a token from email.

Request Body schema: application/json
required
token
required
string
newPassword
required
string <password> >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "newPassword": "pa$$word"
}

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Start passwordless login

Start a passwordless login via magic link or email OTP.

Request Body schema: application/json
required
email
required
string <email>
type
required
string
Enum: "magic_link" "otp"
redirectUrl
string <uri>

Where the magic link should redirect (handled by frontend).

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Verify passwordless OTP

Verify email OTP and return tokens. Magic links are handled by redirect to frontend which exchanges token.

Request Body schema: application/json
required
email
required
string <email>
otp
required
string [ 4 .. 12 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "otp": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "tokens": {
    }
}

Content

Levels, categories, words, and sentences.

List levels

List supported CEFR levels.

Responses

Response samples

Content type
application/json
[
  • "A1"
]

List categories

List vocabulary categories filtered by level/access.

query Parameters
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"
Example: level=A1

CEFR proficiency level.

groupId
string <uuid>
access
string (AccessType)
Enum: "free" "paid"
Example: access=free

Access classification for content.

isHighFrequency
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List words

List words filtered by category, level, frequency, and search.

Authorizations:
bearerAuth
query Parameters
categoryId
string <uuid>
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"
Example: level=A1

CEFR proficiency level.

q
string

Full-text search query.

frequencyMin
integer >= 1
frequencyMax
integer >= 1
page
integer >= 1
Default: 1
pageSize
integer [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "total": 0
}

Get word

Get a single word by id.

Authorizations:
bearerAuth
path Parameters
wordId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "term": "hei",
  • "translation": "hello",
  • "phonetics": "/hæɪ/",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "frequencyRank": 120,
  • "exampleSentences": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List sentences

List sentences filtered by category, level, and search.

Authorizations:
bearerAuth
query Parameters
categoryId
string <uuid>
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"
Example: level=A1

CEFR proficiency level.

q
string

Full-text search query.

page
integer >= 1
Default: 1
pageSize
integer [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "total": 0
}

Get sentence

Get a single sentence by id.

Authorizations:
bearerAuth
path Parameters
sentenceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "text": "string",
  • "translation": "string",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "relatedWordIds": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List category groups

Top-level groups for organizing categories.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Quizzes

Practice quizzes based on words and categories.

List quizzes

Authorizations:
bearerAuth
query Parameters
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"
Example: level=A1

CEFR proficiency level.

categoryId
string <uuid>
type
string
Enum: "words" "sentences" "mixed"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get quiz

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "type": "words",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "access": "free"
}

Start quiz

Start a quiz attempt and receive generated questions.

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "attemptId": "ff88f33b-bb8d-4c28-947a-07ff3d628b10",
  • "quizId": "5d9f833a-900c-4aa4-8bcb-33e2406f23e1",
  • "questions": [
    ]
}

Submit quiz

Submit answers for the ongoing quiz attempt.

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>
Request Body schema: application/json
required
attemptId
required
string <uuid>
required
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "attemptId": "ff88f33b-bb8d-4c28-947a-07ff3d628b10",
  • "answers": [
    ]
}

Response samples

Content type
application/json
{
  • "attemptId": "ff88f33b-bb8d-4c28-947a-07ff3d628b10",
  • "quizId": "5d9f833a-900c-4aa4-8bcb-33e2406f23e1",
  • "score": 100,
  • "correctCount": 0,
  • "wrongCount": 0,
  • "breakdown": [
    ]
}

Profile

User profile management.

Get my profile

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "levelPreference": "A1",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update my profile

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
levelPreference
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "levelPreference": "A1"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "levelPreference": "A1",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Progress

User learning progress.

Get my progress

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "level": "A1",
  • "wordProgress": [
    ],
  • "categoryProgress": [
    ]
}

Update progress

Update progress for a specific word or category.

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
wordId
required
string <uuid>
result
required
string
Enum: "correct" "wrong"
categoryId
string <uuid>
progressPercent
number [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "wordId": "57f23edb-21e0-4045-93bd-dcd64d814bb0",
  • "result": "correct",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "progressPercent": 100
}

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Subscriptions

Subscription plans and user subscription.

List subscription plans

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get my subscription

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
  • "status": "active",
  • "currentPeriodEnd": "2019-08-24T14:15:22Z",
  • "cancelAtPeriodEnd": true
}

Change my subscription

Subscribe or change plan.

Authorizations:
bearerAuth
Request Body schema: application/json
required
planId
required
string <uuid>
cancelAtPeriodEnd
boolean

Responses

Request samples

Content type
application/json
{
  • "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
  • "cancelAtPeriodEnd": true
}

Response samples

Content type
application/json
{
  • "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
  • "status": "active",
  • "currentPeriodEnd": "2019-08-24T14:15:22Z",
  • "cancelAtPeriodEnd": true
}

Admin Users

Admin: manage users.

List users

Admin-only. List users with filters.

Authorizations:
bearerAuth
query Parameters
q
string
role
string
Enum: "user" "admin"
status
string
Enum: "active" "banned" "inactive"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or invite user

Admin-only. Create a user with password or send an invite magic link.

Authorizations:
bearerAuth
Request Body schema: application/json
required
email
required
string <email>
name
string
role
string
Default: "user"
Enum: "user" "admin"
sendInvite
boolean
Default: true

If true, sends a magic-link invite instead of setting a password.

password
string <password>

Optional if sendInvite=true.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "sendInvite": true,
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "levelPreference": "A1",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get user

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "levelPreference": "A1",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update user

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>
Request Body schema: application/json
required
role
string
Enum: "user" "admin"
status
string
Enum: "active" "banned" "inactive"

Responses

Request samples

Content type
application/json
{
  • "role": "user",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "user",
  • "levelPreference": "A1",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete user

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Admin Categories

Admin: manage categories.

Create category

Authorizations:
bearerAuth
Request Body schema: application/json
required
slug
required
string
name
required
string
description
string
groupId
string <uuid>
level
required
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

access
required
string (AccessType)
Enum: "free" "paid"

Access classification for content.

isHighFrequency
boolean

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "level": "A1",
  • "access": "free",
  • "isHighFrequency": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "daily-conversation",
  • "name": "Daily Conversation",
  • "description": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "level": "A1",
  • "access": "free",
  • "isHighFrequency": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update category

Authorizations:
bearerAuth
path Parameters
categoryId
required
string <uuid>
Request Body schema: application/json
required
slug
string
name
string
description
string
groupId
string <uuid>
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

access
string (AccessType)
Enum: "free" "paid"

Access classification for content.

isHighFrequency
boolean

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "level": "A1",
  • "access": "free",
  • "isHighFrequency": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "daily-conversation",
  • "name": "Daily Conversation",
  • "description": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "level": "A1",
  • "access": "free",
  • "isHighFrequency": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete category

Authorizations:
bearerAuth
path Parameters
categoryId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Admin Words

Admin: manage words.

Create word

Authorizations:
bearerAuth
Request Body schema: application/json
required
term
required
string
translation
string
phonetics
string
level
required
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]
frequencyRank
integer

Responses

Request samples

Content type
application/json
{
  • "term": "string",
  • "translation": "string",
  • "phonetics": "string",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "frequencyRank": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "term": "hei",
  • "translation": "hello",
  • "phonetics": "/hæɪ/",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "frequencyRank": 120,
  • "exampleSentences": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update word

Authorizations:
bearerAuth
path Parameters
wordId
required
string <uuid>
Request Body schema: application/json
required
term
string
translation
string
phonetics
string
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]
frequencyRank
integer

Responses

Request samples

Content type
application/json
{
  • "term": "string",
  • "translation": "string",
  • "phonetics": "string",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "frequencyRank": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "term": "hei",
  • "translation": "hello",
  • "phonetics": "/hæɪ/",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "frequencyRank": 120,
  • "exampleSentences": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete word

Authorizations:
bearerAuth
path Parameters
wordId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Admin Sentences

Admin: manage sentences.

Create sentence

Authorizations:
bearerAuth
Request Body schema: application/json
required
text
required
string
translation
string
level
required
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "translation": "string",
  • "level": "A1",
  • "categoryIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "text": "string",
  • "translation": "string",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "relatedWordIds": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update sentence

Authorizations:
bearerAuth
path Parameters
sentenceId
required
string <uuid>
Request Body schema: application/json
required
text
string
translation
string
level
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "translation": "string",
  • "level": "A1",
  • "categoryIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "text": "string",
  • "translation": "string",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "relatedWordIds": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete sentence

Authorizations:
bearerAuth
path Parameters
sentenceId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Admin Quizzes

Admin: manage quizzes and questions.

Create quiz

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <uuid>
title
required
string
description
string
type
required
string
Enum: "words" "sentences" "mixed"
level
required
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]
access
string (AccessType)
Enum: "free" "paid"

Access classification for content.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "type": "words",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "access": "free"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "type": "words",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "access": "free"
}

Update quiz

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>
Request Body schema: application/json
required
id
required
string <uuid>
title
required
string
description
string
type
required
string
Enum: "words" "sentences" "mixed"
level
required
string (Level)
Enum: "A1" "A2" "B1" "B2" "C1" "C2"

CEFR proficiency level.

categoryIds
Array of strings <uuid> [ items <uuid > ]
access
string (AccessType)
Enum: "free" "paid"

Access classification for content.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "type": "words",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "access": "free"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "type": "words",
  • "level": "A1",
  • "categoryIds": [
    ],
  • "access": "free"
}

Delete quiz

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

List quiz questions

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create quiz question

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>
Request Body schema: application/json
required
One of
required
Array of objects >= 2 items

Provide options; mark one or more as correct with isCorrect.

multipleCorrect
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "options": [
    ],
  • "multipleCorrect": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "multiple_choice",
  • "prompt": "string",
  • "options": [
    ],
  • "multipleCorrect": false,
  • "sourceLanguage": "en",
  • "targetLanguage": "no",
  • "relatedWordId": "f508f075-c32c-4337-96fa-e83740939e23",
  • "relatedSentenceId": "6955a985-4095-47e0-aa2b-a19c61be78ba"
}

Update quiz question

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>
questionId
required
string <uuid>
Request Body schema: application/json
required
One of
required
Array of objects >= 2 items

Provide options; mark one or more as correct with isCorrect.

multipleCorrect
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "options": [
    ],
  • "multipleCorrect": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "multiple_choice",
  • "prompt": "string",
  • "options": [
    ],
  • "multipleCorrect": false,
  • "sourceLanguage": "en",
  • "targetLanguage": "no",
  • "relatedWordId": "f508f075-c32c-4337-96fa-e83740939e23",
  • "relatedSentenceId": "6955a985-4095-47e0-aa2b-a19c61be78ba"
}

Delete quiz question

Authorizations:
bearerAuth
path Parameters
quizId
required
string <uuid>
questionId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}

Admin Category Groups

Admin: manage category groups.

List category groups

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create category group

Authorizations:
bearerAuth
Request Body schema: application/json
required
slug
required
string
name
required
string
description
string
sortOrder
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "sortOrder": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "sortOrder": 0
}

Update category group

Authorizations:
bearerAuth
path Parameters
groupId
required
string <uuid>
Request Body schema: application/json
required
slug
string
name
string
description
string
sortOrder
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "sortOrder": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "sortOrder": 0
}

Delete category group

Authorizations:
bearerAuth
path Parameters
groupId
required
string <uuid>

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "detail": "string",
  • "instance": "string"
}