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.

List streaks

GET

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

Retrieves a paginated list of streaks for the authenticated user, filtered by period type and other criteria

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200OK

application/json

List of streaks retrieved successfully

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.eu-west-1.aworld.cloud/app/v1/streaks?periodType' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "items": [
        {
            "userId": "string",
            "streakRuleId": "string",
            "periodId": "string",
            "status": "ACTIVE",
            "kind": "REGULAR",
            "cadence": "DAY",
            "metric": "DAYS",
            "count": 0,
            "periodType": "DAY",
            "iterationId": 1,
            "goalId": 1,
            "target": 1,
            "perfectWeek": true,
            "perfectMonth": true,
            "perfectYear": true,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ],
    "nextToken": "string"
}

Modified at 2025-09-15 15:56:48

Redeem virtual transaction