Missions

Read one mission

POST/v1/missions/{missionKey}

The same mission the feed returns, for a client showing one on a screen of its own, including a mission curated into a collection only, since the caller named it.

A POST because it writes. Like the feed, asking for a mission the player has become eligible for is what enters them into it.

A mission that does not exist, is switched off, whose deadline has passed, or that is hidden from this player is a 404 in every case.

AuthorizationBearer <token>

Paste a project API key (no 'Bearer ' prefix). Create one in the dashboard under API keys.

In: header

Path Parameters

missionKey*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for a player's collection view.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/missions/string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string"  }'
{  "missionKey": "string",  "name": "string",  "description": null,  "images": {    "property1": "string",    "property2": "string"  },  "status": "Available",  "optInMode": "Automatic",  "isAccepted": true,  "occurrenceNumber": 0,  "objectives": [    {      "objectiveId": "1ac8be30-2b34-409a-be6d-40652b73c978",      "description": null,      "order": 0,      "isSatisfied": true,      "progress": {        "kind": "TowardTarget",        "actual": null,        "operator": null,        "target": null,        "fraction": null      }    }  ],  "rewards": [    {      "kind": "Points",      "pointsAmount": null,      "catalogItemKey": null,      "catalogItemValue": null    }  ],  "startedAtUtc": null,  "acceptedAtUtc": null,  "completedAtUtc": null,  "availableUntilUtc": null}