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 Engage
- API Overview
- Getting Started
- Multi-Tenancy
- Workspaces
- Authentication
- Common Features
- API Reference
- App API Reference (Consumer)
- ActivityLogs
- Missions
- Quizzes
- Stories
- Streaks
- Users
- VirtualBalances
- VirtualTransactions
- Dashboard API Reference (Admin)
- Activities
- MissionConfigurations
- Tags
- List mission configuration tag assignments
- Create multiple mission configuration tag assignments
- Update multiple mission configuration tag assignments
- Delete multiple mission configuration tag assignments
- Create mission configuration tag assignment
- Update mission configuration tag assignment
- Delete mission configuration tag assignment
- Get mission configuration tag assignment
- Translations
- List mission configurations
- Create mission configuration
- Get mission configuration by ID
- Update mission configuration
- Publish mission configuration
- Tags
- MissionRules
- Missions
- Mobility
- Quizzes
- RewardRules
- Stories
- StreakConfigurations
- Tags
- List streak configuration tag assignments
- Create multiple streak configuration tag assignments
- Update multiple streak configuration tag assignments
- Delete multiple streak configuration tag assignments
- Get streak configuration tag assignment
- Create streak configuration tag assignment
- Update streak configuration tag assignment
- Delete streak configuration tag assignment
- Translations
- List streak configurations
- Create streak configuration
- Get streak configuration by ID
- Update streak configuration
- Publish streak configuration
- Tags
- StreakRules
- VirtualCurrencies
- Tags
- Users
- VirtualTransactions
- App API Reference (Consumer)
- Schemas
- App Schemas
- Schemas
- CreateActivityResponse
- CreateVirtualTransactionResponse
- GetCurrentUserPrincipalResponse
- GetCurrentUserResponse
- GetCurrentUserTagResponse
- GetQuizResponse
- GetQuizTagResponse
- GetQuizTranslationResponse
- GetStoryResponse
- GetStoryTagResponse
- GetStoryTranslationResponse
- GetVirtualBalanceResponse
- GetVirtualTransactionResponse
- JsonLogicExpression
- Lang
- ListCurrentUserTagAssignmentsResponse
- ListMissionsResponse
- ListQuizTagAssignmentsResponse
- ListQuizzesResponse
- ListStoriesResponse
- ListStoryTagAssignmentsResponse
- ListStreaksResponse
- ListVirtualBalancesResponse
- ListVirtualTransactionsResponse
- RedeemVirtualTransactionResponse
- SourceRegion
- SubmitQuizResponse
- SubmitStoryResponse
- Timezone
- Dashboard Schemas
- Schemas
- ActivityTranslation
- ActivityWithResolvedFields
- CreateActivityResponse
- CreateActivityTagAssignmentResponse
- CreateActivityTagAssignmentsResponse
- CreateMissionConfigurationResponse
- CreateMissionConfigurationTagAssignmentResponse
- CreateMissionConfigurationTagAssignmentsResponse
- CreateMissionResponse
- CreateMissionRuleResponse
- CreateMissionRuleTagAssignmentResponse
- CreateMissionRuleTagAssignmentsResponse
- CreateQuizResponse
- CreateQuizTagAssignmentResponse
- CreateQuizTagAssignmentsResponse
- CreateRewardRuleResponse
- CreateStoryResponse
- CreateStoryTagAssignmentResponse
- CreateStoryTagAssignmentsResponse
- CreateStreakConfigurationResponse
- CreateStreakConfigurationTagAssignmentResponse
- CreateStreakConfigurationTagAssignmentsResponse
- CreateStreakRuleResponse
- CreateTagResponse
- CreateUserResponse
- CreateVirtualCurrencyResponse
- CreateVirtualTransactionResponse
- DeleteMissionConfigurationTagAssignmentResponse
- DeleteMissionConfigurationTagAssignmentsResponse
- DeleteMissionRuleTagAssignmentResponse
- DeleteMissionRuleTagAssignmentsResponse
- DeleteQuizTagAssignmentResponse
- DeleteQuizTagAssignmentsResponse
- DeleteStoryTagAssignmentResponse
- DeleteStoryTagAssignmentsResponse
- DeleteStreakConfigurationTagAssignmentResponse
- DeleteStreakConfigurationTagAssignmentsResponse
- DeleteUserResponse
- GetActivityResponse
- GetActivityTagAssignmentResponse
- GetMissionConfigurationResponse
- GetMissionConfigurationTagAssignmentResponse
- GetMissionRuleResponse
- GetMissionRuleTagAssignmentResponse
- GetMobilityActivationResponse
- GetMobilityMilestoneResponse
- GetMotionTagStatusResponse
- GetMotionTagTokenResponse
- GetQuizResponse
- GetQuizTagAssignmentResponse
- GetRewardRuleResponse
- GetStoryResponse
- GetStoryTagAssignmentResponse
- GetStreakConfigurationResponse
- GetStreakConfigurationTagAssignmentResponse
- GetStreakRuleResponse
- GetStreakRuleTagAssignmentResponse
- GetTagResponse
- GetUserByExternalIdResponse
- GetUserResponse
- GetUserTagAssignmentResponse
- GetVirtualCurrencyResponse
- JsonLogicExpression
- Lang
- ListActivitiesResponse
- ListActivityTagAssignmentsResponse
- ListActivityTranslationsResponse
- ListMissionConfigurationsResponse
- ListMissionConfigurationTagAssignmentsResponse
- ListMissionConfigurationTranslationsResponse
- ListMissionRulesResponse
- ListMissionRuleTagAssignmentsResponse
- ListMissionRuleTranslationsResponse
- ListMobilityMilestonesResponse
- ListMobilityTrackingsResponse
- ListQuizTagAssignmentsResponse
- ListQuizTranslationsResponse
- ListQuizzesResponse
- ListRewardRulesResponse
- ListStoriesResponse
- ListStoryTagAssignmentsResponse
- ListStoryTranslationsResponse
- ListStreakConfigurationsResponse
- ListStreakConfigurationTagAssignmentsResponse
- ListStreakConfigurationTranslationsResponse
- ListStreakRulesResponse
- ListStreakRuleTranslationResponse
- ListTagsResponse
- ListUsersResponse
- ListVirtualCurrenciesResponse
- ListVirtualCurrencyTranslationResponse
- PublishActivityResponse
- PublishMissionConfigurationResponse
- PublishMissionRuleResponse
- PublishQuizResponse
- PublishRewardRuleResponse
- PublishStoryResponse
- PublishStreakConfigurationResponse
- PublishStreakRuleResponse
- PublishTagResponse
- PublishVirtualCurrencyResponse
- RedeemMobilityMilestoneResponse
- SourceRegion
- StreakRuleTagAssignmentsCollection
- StreakRuleTagAssignmentsList
- Timezone
- UpdateActivityResponse
- UpdateActivityTagAssignmentResponse
- UpdateActivityTagAssignmentsResponse
- UpdatedStreakRuleTagAssignmentsCollection
- UpdatedUserTagAssignmentsCollection
- UpdateMissionConfigurationResponse
- UpdateMissionConfigurationTagAssignmentResponse
- UpdateMissionConfigurationTagAssignmentsResponse
- UpdateMissionRuleResponse
- UpdateMissionRuleTagAssignmentResponse
- UpdateMissionRuleTagAssignmentsResponse
- UpdateMobilityActivationResponse
- UpdateQuizResponse
- UpdateQuizTagAssignmentResponse
- UpdateQuizTagAssignmentsResponse
- UpdateRewardRuleResponse
- UpdateStoryResponse
- UpdateStoryTagAssignmentResponse
- UpdateStoryTagAssignmentsResponse
- UpdateStreakConfigurationResponse
- UpdateStreakConfigurationTagAssignmentResponse
- UpdateStreakConfigurationTagAssignmentsResponse
- UpdateStreakRuleResponse
- UpdateStreakRuleTagAssignmentResponse
- UpdateTagResponse
- UpdateUserTagAssignmentResponse
- UpdateVirtualCurrencyResponse
- UserTagAssignmentsCollection
- UserTagAssignmentsList
- Schemas
GetVirtualBalanceResponse
{
"userId": "string",
"virtualCurrencyId": "string",
"amount": 0,
"availableAmount": 0,
"createdAt": "2019-08-24T14:15:22.123Z",
"updatedAt": "2019-08-24T14:15:22.123Z"
}