Get assignment

GET

/assignments/{assignmentId}

Assignments

Retrieve a specific assignment by ID, with optional additional fields (translation, tags, items, progress).

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Assignment retrieved successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/app/v1/assignments/?context=undefined&fields=undefined' \
--header 'x-external-user-id;' \
--header 'x-user-id;'

Response Example

{
    "targetId": "FUMzPf00hz_kcj2R2Hlzq",
    "assignmentId": "FUMzPf00hz_kcj2R2Hlzq",
    "targetType": "survey",
    "userId": "string",
    "assignmentRuleId": "FUMzPf00hz_kcj2R2Hlzq",
    "contributingRuleIds": [
        "FUMzPf00hz_kcj2R2Hlzq"
    ],
    "groupId": "string",
    "periodId": "string",
    "timeframeType": "PERMANENT",
    "startsAt": "2019-08-24T14:15:22.123Z",
    "endsAt": "2019-08-24T14:15:22.123Z",
    "state": "PENDING",
    "visibility": "LOCKED",
    "assignmentType": "REQUIRED",
    "priority": 0,
    "unlockedAt": "2019-08-24T14:15:22.123Z",
    "unlockedByRuleId": "FUMzPf00hz_kcj2R2Hlzq",
    "currentAttempt": 1,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "tags": [
        {
            "tagId": "string",
            "priority": 0,
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "progress": {
        "status": "NOT_STARTED",
        "outcome": "SUCCESS",
        "attempt": 1,
        "startedAt": "string",
        "completedAt": "string",
        "property1": "string",
        "property2": "string"
    },
    "translation": {
        "lang": "en",
        "title": "string",
        "description": "string",
        "property1": "string",
        "property2": "string"
    },
    "items": [
        {
            "itemId": "string",
            "itemType": "string",
            "property1": "string",
            "property2": "string"
        }
    ],
    "rewardsPreview": [
        {
            "rewardRuleId": "string",
            "rewardRuleName": "string",
            "rewardType": "VIRTUAL_CURRENCY",
            "virtualCurrencyId": "string",
            "amount": 1
        }
    ],
    "property1": "string",
    "property2": "string"
}

Modified at 2026-09-10 08:51:45

List assignments

Search assignments