AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

List user's missions

GET

https://api.eu-west-1.aworld.cloud/app/v1/missions

Missions

Retrieves a paginated list of missions assigned to the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.eu-west-1.aworld.cloud/app/v1/missions'

Response Example

{
    "items": [
        {
            "missionAssignmentId": "string",
            "missionType": "INDIVIDUAL",
            "missionId": "string",
            "missionRuleId": "string",
            "periodId": "string",
            "timeframeType": "PERMANENT",
            "startsAt": "2019-08-24T14:15:22Z",
            "endsAt": "2019-08-24T14:15:22Z",
            "completedAt": "2019-08-24T14:15:22Z",
            "isCompleted": true,
            "state": "PENDING",
            "groupTagId": "string",
            "userId": "string",
            "currentAmount": 0,
            "targetAmount": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ],
    "nextToken": "string"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

nextToken

string

optional

Pagination token for fetching the next set of results.

limit

integer

optional

Maximum number of assigned missions to return per page.

Default:

Responses

🟢200OK

application/json

List of assigned missions retrieved successfully.

Body

items

array[object (AppMissionAssignment) {17}]

optional

missionAssignmentId

string

required

Unique identifier for the mission assignment.

missionType

enum<string>

required

Type of the assigned mission.

Allowed values:

INDIVIDUALGROUP

missionId

string

required

Identifier of the assigned mission.

missionRuleId

string

optional

Optional. Identifier of the mission rule that triggered this assignment.

periodId

string

required

Identifier for the specific period of a recurring mission assignment.

timeframeType

enum<string>

required

The timeframe type of this assignment.

Allowed values:

PERMANENTRANGERECURRING

startsAt

string <date-time>

required

Start date-time of this mission assignment.

endsAt

string <date-time>

optional

Optional. End date-time of this mission assignment.

completedAt

string <date-time>

optional

Optional. Timestamp when the mission assignment was completed.

isCompleted

boolean

optional

Indicates if the mission assignment is completed.

state

enum<string>

required

Current state of the mission assignment.

Allowed values:

PENDINGACTIVEENDED

groupTagId

string

optional

If missionType is 'GROUP', the tag ID of the assigned group.

userId

string

optional

If missionType is 'INDIVIDUAL', the ID of the assigned user.

currentAmount

number

required

Current progress amount towards the target.

targetAmount

number

required

Target amount required for mission completion.

createdAt

string <date-time>

optional

Timestamp when the assignment was created.

updatedAt

string <date-time>

optional

Timestamp when the assignment was last updated.

nextToken

string

optional

Pagination token for the next set of results.

🟠401Unauthorized

Modified at 2025-06-25 15:15:28

Redeem virtual transaction

Dashboard API Reference (Admin)