Missions

Mission management and user mission tracking

Get all missions

get
/api/missions

Retrieve all missions or only active missions (Admin only)

Query parameters
allbooleanOptional

Include inactive missions

Responses
chevron-right
200

List of missions

application/json
get
/api/missions
200

List of missions

Create a new mission

post
/api/missions

Create a new mission campaign (Admin only)

Body
descriptionstringRequired

Mission description

Example: Complete 3 mini-games to earn rewards
campaign_keystringRequired

Campaign identifier for reward system

Example: minigames-season-1
typestring · enumRequired

Mission type

Example: mini-gamesPossible values:
thumb_urlstringRequired

Thumbnail image URL

Example: https://example.com/mission-thumb.png
Responses
post
/api/missions

Get mission details

get
/api/missions/{id}

Retrieve mission details including associated challenges and games (Admin only)

Path parameters
idstring · uuidRequired

Mission ID (UUID)

Responses
chevron-right
200

Mission details

application/json
get
/api/missions/{id}
200

Mission details

Update a mission

patch
/api/missions/{id}

Update an existing mission (Admin only)

Path parameters
idstring · uuidRequired

Mission ID (UUID)

Body
descriptionstringRequired

Mission description

Example: Complete 3 mini-games to earn rewards
campaign_keystringRequired

Campaign identifier for reward system

Example: minigames-season-1
typestring · enumRequired

Mission type

Example: mini-gamesPossible values:
thumb_urlstringRequired

Thumbnail image URL

Example: https://example.com/mission-thumb.png
Responses
patch
/api/missions/{id}

No content

Get available missions for user

get
/api/missions/available

Retrieve missions available to start for the authenticated user

Query parameters
typestring · enumOptional

Mission type filter

Default: mini-gamesPossible values:
Responses
chevron-right
200

List of available missions

application/json
get
/api/missions/available
200

List of available missions

Get missions in progress

get
/api/missions/in_progress

Retrieve missions currently in progress for the authenticated user with challenges and games

Query parameters
typestring · enumOptional

Mission type filter

Default: mini-gamesPossible values:
Responses
chevron-right
200

Missions in progress with challenges and games

application/json
get
/api/missions/in_progress
200

Missions in progress with challenges and games

Get completed missions

get
/api/missions/completed

Retrieve missions completed by the authenticated user with challenges and games

Query parameters
typestring · enumOptional

Mission type filter

Default: mini-gamesPossible values:
Responses
chevron-right
200

Completed missions with challenges and games

application/json
get
/api/missions/completed
200

Completed missions with challenges and games

Start a mission

post
/api/missions/{id}/start

Start a mission for the authenticated user.

Rules:

  • Mini-games missions: Only one active mission at a time, with time window restrictions between missions

  • Fashion Week missions: Can have multiple active, switching between them marks previous as incomplete

  • Mission must exist and have a valid type

Path parameters
idstring · uuidRequired

Mission ID (UUID)

Responses
post
/api/missions/{id}/start

No content

Last updated