Missions
List a player's missions
POST
/v1/missionsReturns the player's mission feed: the missions they are already in, plus any they have newly become eligible for.
A POST because it writes. Returning a mission the player has become eligible for is what enters them into it, after this call they are in it, and their events start counting toward it. That is why it is not a GET, and why the answer should not be cached.
Authorization
ApiKey AuthorizationBearer <token>
Paste a project API key (no 'Bearer ' prefix). Create one in the dashboard under API keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for the mission feed.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/missions" \ -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 }]