# AWorld API ## Docs - AWorld Engage [Engagement for Businesses and Organizations](https://saas.aworld.org/engagement-for-businesses-and-organizations-1207407m0.md): - AWorld Engage [API-first for Gamification](https://saas.aworld.org/api-first-for-gamification-1215192m0.md): - AWorld Engage [Gamification Features and Mechanics](https://saas.aworld.org/gamification-features-and-mechanics-1215194m0.md): - AWorld Engage [Infrastructure and Technology](https://saas.aworld.org/infrastructure-and-technology-1215195m0.md): - AWorld Engage [Technical Details](https://saas.aworld.org/technical-details-1215196m0.md): - API Overview [Getting Started](https://saas.aworld.org/getting-started-1220979m0.md): - API Overview [Multi-Tenancy](https://saas.aworld.org/multi-tenancy-1215383m0.md): - API Overview [Workspaces](https://saas.aworld.org/workspaces-1215382m0.md): - API Overview [Authentication](https://saas.aworld.org/authentication-1215379m0.md): - API Overview [Common Features](https://saas.aworld.org/common-features-1221000m0.md): - API Overview > API Reference [App API Reference (Consumer)](https://saas.aworld.org/app-api-reference.md): - API Overview > API Reference [Dashboard API Reference (Admin)](https://saas.aworld.org/dashboard-api-reference.md): - [Getting Started](https://saas.aworld.org/getting-started-1220979m0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - [Multi-Tenancy](https://saas.aworld.org/multi-tenancy-1215383m0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - [Workspaces](https://saas.aworld.org/workspaces-1215382m0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - [Authentication](https://saas.aworld.org/authentication-1215379m0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - [Common Features](https://saas.aworld.org/common-features-1221000m0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - API Reference [App API Reference (Consumer)](https://saas.aworld.org/app-api-reference.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): - API Reference [Dashboard API Reference (Admin)](https://saas.aworld.org/dashboard-api-reference.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): ## API Docs - API Overview > API Reference > App API Reference (Consumer) > Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18468608e0.md): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - API Overview > API Reference > App API Reference (Consumer) > ActivityLogs [Create activity log](https://saas.aworld.org/create-activity-log-18468609e0.md): Records a user's activity completion by creating a new activity log entry with an auto-generated ID - API Overview > API Reference > App API Reference (Consumer) > ActivityLogs [Create/update activity log](https://saas.aworld.org/createupdate-activity-log-18468610e0.md): Records a user's activity completion by creating or updating an activity log entry with the provided ID. This endpoint is useful for idempotent operations when you need to ensure the same activity completion is not recorded multiple times. - API Overview > API Reference > App API Reference (Consumer) > Quizzes [List quizzes](https://saas.aworld.org/list-quizzes-18468611e0.md): Retrieves a paginated list of available quizzes for the authenticated user - API Overview > API Reference > App API Reference (Consumer) > Quizzes [Get quiz](https://saas.aworld.org/get-quiz-18468612e0.md): Retrieves a quiz object with associated content, excluding the correct answer for client-side display purposes. - API Overview > API Reference > App API Reference (Consumer) > Quizzes [Get quiz translation](https://saas.aworld.org/get-quiz-translation-18468613e0.md): Retrieves the translation content for a specific quiz, including questions and answer options - API Overview > API Reference > App API Reference (Consumer) > VirtualBalances [List virtual balances](https://saas.aworld.org/list-virtual-balances-18468614e0.md): Retrieves a paginated list of virtual currency balances for the authenticated user. - API Overview > API Reference > App API Reference (Consumer) > VirtualBalances [Get virtual balance](https://saas.aworld.org/get-virtual-balance-18468615e0.md): Retrieves the balance for a specific virtual currency for the authenticated user. - API Overview > API Reference > App API Reference (Consumer) > VirtualTransactions [List virtual transactions](https://saas.aworld.org/list-virtual-transactions-18468616e0.md): Retrieves a paginated list of virtual transactions for the authenticated user. - API Overview > API Reference > App API Reference (Consumer) > VirtualTransactions [Create virtual transactions](https://saas.aworld.org/create-virtual-transactions-18468617e0.md): Allows a user to send virtual currency to another user. Multiple transaction requests can be batched. The source user is always the authenticated caller. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries. - API Overview > API Reference > App API Reference (Consumer) > VirtualTransactions [Get virtual transaction](https://saas.aworld.org/get-virtual-transaction-18468618e0.md): Retrieves a specific virtual transaction by its ID for the authenticated user. - API Overview > API Reference > App API Reference (Consumer) > VirtualTransactions [Redeem virtual transaction](https://saas.aworld.org/redeem-virtual-transaction-18468619e0.md): Redeems a specific pending credit virtual transaction for the authenticated user. This action is typically available for transactions with 'MANUAL' redemption mode. Redeeming a transaction may also complete other related transactions (e.g., a corresponding debit) if they share the same redemptionGroupId. - API Overview > API Reference > App API Reference (Consumer) > Missions [List user's missions](https://saas.aworld.org/list-users-missions-18468620e0.md): Retrieves a paginated list of missions assigned to the authenticated user. - API Overview > API Reference > Dashboard API Reference (Admin) > Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18507512e0.md): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - API Overview > API Reference > Dashboard API Reference (Admin) > Activity [List activities](https://saas.aworld.org/list-activities-18507450e0.md): Retrieves a paginated list of activities available in the workspace - API Overview > API Reference > Dashboard API Reference (Admin) > Activity [Get activity by ID](https://saas.aworld.org/get-activity-by-id-18507451e0.md): Retrieves a specific activity by its unique identifier - API Overview > API Reference > Dashboard API Reference (Admin) > Activity [Create activity](https://saas.aworld.org/create-activity-18507452e0.md): Creates a new activity with the specified ID. It is recommended to use a human-readable ID. - API Overview > API Reference > Dashboard API Reference (Admin) > Activity [Update activity](https://saas.aworld.org/update-activity-18507453e0.md): Updates an existing activity identified by its ID - API Overview > API Reference > Dashboard API Reference (Admin) > Activity [Publish an activity](https://saas.aworld.org/publish-an-activity-18507454e0.md): Publishes an activity, making it available for use in the application - API Overview > API Reference > Dashboard API Reference (Admin) > Missions [List missions](https://saas.aworld.org/list-missions-18507475e0.md): Retrieves a paginated list of missions available in the workspace. - API Overview > API Reference > Dashboard API Reference (Admin) > Missions [Create mission](https://saas.aworld.org/create-mission-18507476e0.md): Creates a new mission with a system-generated ID. - API Overview > API Reference > Dashboard API Reference (Admin) > Missions [Get mission by ID](https://saas.aworld.org/get-mission-by-id-18507477e0.md): Retrieves a specific mission by its unique identifier. - API Overview > API Reference > Dashboard API Reference (Admin) > Missions [Update mission](https://saas.aworld.org/update-mission-18507478e0.md): Updates an existing mission identified by its ID. - API Overview > API Reference > Dashboard API Reference (Admin) > Missions [Publish a mission](https://saas.aworld.org/publish-a-mission-18507479e0.md): Publishes a mission, making it available for use. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionRules [List mission rules](https://saas.aworld.org/list-mission-rules-18507480e0.md): Retrieves a paginated list of mission rules available in the workspace. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionRules [Create mission rule](https://saas.aworld.org/create-mission-rule-18507481e0.md): Creates a new mission rule with a system-generated ID. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionRules [Get mission rule by ID](https://saas.aworld.org/get-mission-rule-by-id-18507482e0.md): Retrieves a specific mission rule by its unique identifier. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionRules [Update mission rule](https://saas.aworld.org/update-mission-rule-18507483e0.md): Updates an existing mission rule identified by its ID. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionRules [Publish a mission rule](https://saas.aworld.org/publish-a-mission-rule-18507484e0.md): Publishes a mission rule, making it active. - API Overview > API Reference > Dashboard API Reference (Admin) > MissionAssignments [Create mission assignment (manual)](https://saas.aworld.org/create-mission-assignment-manual-18507485e0.md): Manually assigns a mission to a user or a group. This is typically used for specific cases not covered by mission rules. - API Overview > API Reference > Dashboard API Reference (Admin) > RewardRules [List reward rules](https://saas.aworld.org/list-reward-rules-18507460e0.md): Retrieves a paginated list of reward rules available in the workspace - API Overview > API Reference > Dashboard API Reference (Admin) > RewardRules [Create reward rule](https://saas.aworld.org/create-reward-rule-18507461e0.md): Creates a new reward rule with a system-generated ID - API Overview > API Reference > Dashboard API Reference (Admin) > RewardRules [Get reward rule by ID](https://saas.aworld.org/get-reward-rule-by-id-18507462e0.md): Retrieves a specific reward rule by its unique identifier - API Overview > API Reference > Dashboard API Reference (Admin) > RewardRules [Update reward rule](https://saas.aworld.org/update-reward-rule-18507463e0.md): Updates an existing reward rule identified by its ID - API Overview > API Reference > Dashboard API Reference (Admin) > RewardRules [Publish a reward rule](https://saas.aworld.org/publish-a-reward-rule-18507464e0.md): Publishes a reward rule, making it available for use in the application - API Overview > API Reference > Dashboard API Reference (Admin) > Tags [List tags](https://saas.aworld.org/list-tags-18507465e0.md): Retrieves a paginated list of tags available in the workspace - API Overview > API Reference > Dashboard API Reference (Admin) > Tags [Create tag](https://saas.aworld.org/create-tag-18507466e0.md): Creates a new tag with a system-generated ID - API Overview > API Reference > Dashboard API Reference (Admin) > Tags [Get tag by ID](https://saas.aworld.org/get-tag-by-id-18507467e0.md): Retrieves a specific tag by its unique identifier - API Overview > API Reference > Dashboard API Reference (Admin) > Tags [Update tag](https://saas.aworld.org/update-tag-18507468e0.md): Updates an existing tag identified by its ID - API Overview > API Reference > Dashboard API Reference (Admin) > Tags [Publish a tag](https://saas.aworld.org/publish-a-tag-18507469e0.md): Publishes a tag, making it available for use in the application - API Overview > API Reference > Dashboard API Reference (Admin) > Users [List users](https://saas.aworld.org/list-users-18507470e0.md): Retrieves a paginated list of users available in the workspace - API Overview > API Reference > Dashboard API Reference (Admin) > Users [Create user](https://saas.aworld.org/create-user-18507471e0.md): Creates a new user in the system with generated credentials - API Overview > API Reference > Dashboard API Reference (Admin) > Users [Get user by ID](https://saas.aworld.org/get-user-by-id-18507472e0.md): Retrieves a specific user by their unique identifier - API Overview > API Reference > Dashboard API Reference (Admin) > Users [Get user by external ID](https://saas.aworld.org/get-user-by-external-id-18507473e0.md): Retrieves a specific user by their unique external ID identifier - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [List virtual currencies](https://saas.aworld.org/list-virtual-currencies-18507455e0.md): Retrieves a paginated list of virtual currencies available in the workspace - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Get virtual currency by ID](https://saas.aworld.org/get-virtual-currency-by-id-18507456e0.md): Retrieves a specific virtual currency by its unique identifier - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Create virtual currency](https://saas.aworld.org/create-virtual-currency-18507457e0.md): Creates a new virtual currency with the specified ID. It is recommended to use a human-readable ID. - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Update virtual currency](https://saas.aworld.org/update-virtual-currency-18507458e0.md): Updates an existing virtual currency identified by its ID - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Publish virtual currency](https://saas.aworld.org/publish-virtual-currency-18507459e0.md): Publishes a virtual currency, making it available for use in the application - API Overview > API Reference > Dashboard API Reference (Admin) > VirtualTransactions [Create new virtual transactions (Admin)](https://saas.aworld.org/create-new-virtual-transactions-admin-18507474e0.md): Allows an administrator to create transactions between users, or between a user and the system. Multiple transaction requests can be batched. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries. - API Reference > App API Reference (Consumer) > Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18468608e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - API Reference > App API Reference (Consumer) > ActivityLogs [Create activity log](https://saas.aworld.org/create-activity-log-18468609e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Records a user's activity completion by creating a new activity log entry with an auto-generated ID - API Reference > App API Reference (Consumer) > ActivityLogs [Create/update activity log](https://saas.aworld.org/createupdate-activity-log-18468610e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Records a user's activity completion by creating or updating an activity log entry with the provided ID. This endpoint is useful for idempotent operations when you need to ensure the same activity completion is not recorded multiple times. - API Reference > App API Reference (Consumer) > Quizzes [List quizzes](https://saas.aworld.org/list-quizzes-18468611e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of available quizzes for the authenticated user - API Reference > App API Reference (Consumer) > Quizzes [Get quiz](https://saas.aworld.org/get-quiz-18468612e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a quiz object with associated content, excluding the correct answer for client-side display purposes. - API Reference > App API Reference (Consumer) > Quizzes [Get quiz translation](https://saas.aworld.org/get-quiz-translation-18468613e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves the translation content for a specific quiz, including questions and answer options - API Reference > App API Reference (Consumer) > VirtualBalances [List virtual balances](https://saas.aworld.org/list-virtual-balances-18468614e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of virtual currency balances for the authenticated user. - API Reference > App API Reference (Consumer) > VirtualBalances [Get virtual balance](https://saas.aworld.org/get-virtual-balance-18468615e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves the balance for a specific virtual currency for the authenticated user. - API Reference > App API Reference (Consumer) > VirtualTransactions [List virtual transactions](https://saas.aworld.org/list-virtual-transactions-18468616e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of virtual transactions for the authenticated user. - API Reference > App API Reference (Consumer) > VirtualTransactions [Create virtual transactions](https://saas.aworld.org/create-virtual-transactions-18468617e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Allows a user to send virtual currency to another user. Multiple transaction requests can be batched. The source user is always the authenticated caller. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries. - API Reference > App API Reference (Consumer) > VirtualTransactions [Get virtual transaction](https://saas.aworld.org/get-virtual-transaction-18468618e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific virtual transaction by its ID for the authenticated user. - API Reference > App API Reference (Consumer) > VirtualTransactions [Redeem virtual transaction](https://saas.aworld.org/redeem-virtual-transaction-18468619e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Redeems a specific pending credit virtual transaction for the authenticated user. This action is typically available for transactions with 'MANUAL' redemption mode. Redeeming a transaction may also complete other related transactions (e.g., a corresponding debit) if they share the same redemptionGroupId. - API Reference > App API Reference (Consumer) > Missions [List user's missions](https://saas.aworld.org/list-users-missions-18468620e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of missions assigned to the authenticated user. - API Reference > Dashboard API Reference (Admin) > Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18507512e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - API Reference > Dashboard API Reference (Admin) > Activity [List activities](https://saas.aworld.org/list-activities-18507450e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of activities available in the workspace - API Reference > Dashboard API Reference (Admin) > Activity [Get activity by ID](https://saas.aworld.org/get-activity-by-id-18507451e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific activity by its unique identifier - API Reference > Dashboard API Reference (Admin) > Activity [Create activity](https://saas.aworld.org/create-activity-18507452e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new activity with the specified ID. It is recommended to use a human-readable ID. - API Reference > Dashboard API Reference (Admin) > Activity [Update activity](https://saas.aworld.org/update-activity-18507453e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing activity identified by its ID - API Reference > Dashboard API Reference (Admin) > Activity [Publish an activity](https://saas.aworld.org/publish-an-activity-18507454e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes an activity, making it available for use in the application - API Reference > Dashboard API Reference (Admin) > Missions [List missions](https://saas.aworld.org/list-missions-18507475e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of missions available in the workspace. - API Reference > Dashboard API Reference (Admin) > Missions [Create mission](https://saas.aworld.org/create-mission-18507476e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new mission with a system-generated ID. - API Reference > Dashboard API Reference (Admin) > Missions [Get mission by ID](https://saas.aworld.org/get-mission-by-id-18507477e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific mission by its unique identifier. - API Reference > Dashboard API Reference (Admin) > Missions [Update mission](https://saas.aworld.org/update-mission-18507478e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing mission identified by its ID. - API Reference > Dashboard API Reference (Admin) > Missions [Publish a mission](https://saas.aworld.org/publish-a-mission-18507479e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes a mission, making it available for use. - API Reference > Dashboard API Reference (Admin) > MissionRules [List mission rules](https://saas.aworld.org/list-mission-rules-18507480e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of mission rules available in the workspace. - API Reference > Dashboard API Reference (Admin) > MissionRules [Create mission rule](https://saas.aworld.org/create-mission-rule-18507481e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new mission rule with a system-generated ID. - API Reference > Dashboard API Reference (Admin) > MissionRules [Get mission rule by ID](https://saas.aworld.org/get-mission-rule-by-id-18507482e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific mission rule by its unique identifier. - API Reference > Dashboard API Reference (Admin) > MissionRules [Update mission rule](https://saas.aworld.org/update-mission-rule-18507483e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing mission rule identified by its ID. - API Reference > Dashboard API Reference (Admin) > MissionRules [Publish a mission rule](https://saas.aworld.org/publish-a-mission-rule-18507484e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes a mission rule, making it active. - API Reference > Dashboard API Reference (Admin) > MissionAssignments [Create mission assignment (manual)](https://saas.aworld.org/create-mission-assignment-manual-18507485e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Manually assigns a mission to a user or a group. This is typically used for specific cases not covered by mission rules. - API Reference > Dashboard API Reference (Admin) > RewardRules [List reward rules](https://saas.aworld.org/list-reward-rules-18507460e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of reward rules available in the workspace - API Reference > Dashboard API Reference (Admin) > RewardRules [Create reward rule](https://saas.aworld.org/create-reward-rule-18507461e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new reward rule with a system-generated ID - API Reference > Dashboard API Reference (Admin) > RewardRules [Get reward rule by ID](https://saas.aworld.org/get-reward-rule-by-id-18507462e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific reward rule by its unique identifier - API Reference > Dashboard API Reference (Admin) > RewardRules [Update reward rule](https://saas.aworld.org/update-reward-rule-18507463e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing reward rule identified by its ID - API Reference > Dashboard API Reference (Admin) > RewardRules [Publish a reward rule](https://saas.aworld.org/publish-a-reward-rule-18507464e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes a reward rule, making it available for use in the application - API Reference > Dashboard API Reference (Admin) > Tags [List tags](https://saas.aworld.org/list-tags-18507465e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of tags available in the workspace - API Reference > Dashboard API Reference (Admin) > Tags [Create tag](https://saas.aworld.org/create-tag-18507466e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new tag with a system-generated ID - API Reference > Dashboard API Reference (Admin) > Tags [Get tag by ID](https://saas.aworld.org/get-tag-by-id-18507467e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific tag by its unique identifier - API Reference > Dashboard API Reference (Admin) > Tags [Update tag](https://saas.aworld.org/update-tag-18507468e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing tag identified by its ID - API Reference > Dashboard API Reference (Admin) > Tags [Publish a tag](https://saas.aworld.org/publish-a-tag-18507469e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes a tag, making it available for use in the application - API Reference > Dashboard API Reference (Admin) > Users [List users](https://saas.aworld.org/list-users-18507470e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of users available in the workspace - API Reference > Dashboard API Reference (Admin) > Users [Create user](https://saas.aworld.org/create-user-18507471e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new user in the system with generated credentials - API Reference > Dashboard API Reference (Admin) > Users [Get user by ID](https://saas.aworld.org/get-user-by-id-18507472e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific user by their unique identifier - API Reference > Dashboard API Reference (Admin) > Users [Get user by external ID](https://saas.aworld.org/get-user-by-external-id-18507473e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific user by their unique external ID identifier - API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [List virtual currencies](https://saas.aworld.org/list-virtual-currencies-18507455e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a paginated list of virtual currencies available in the workspace - API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Get virtual currency by ID](https://saas.aworld.org/get-virtual-currency-by-id-18507456e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Retrieves a specific virtual currency by its unique identifier - API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Create virtual currency](https://saas.aworld.org/create-virtual-currency-18507457e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Creates a new virtual currency with the specified ID. It is recommended to use a human-readable ID. - API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Update virtual currency](https://saas.aworld.org/update-virtual-currency-18507458e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Updates an existing virtual currency identified by its ID - API Reference > Dashboard API Reference (Admin) > VirtualCurrencies [Publish virtual currency](https://saas.aworld.org/publish-virtual-currency-18507459e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Publishes a virtual currency, making it available for use in the application - API Reference > Dashboard API Reference (Admin) > VirtualTransactions [Create new virtual transactions (Admin)](https://saas.aworld.org/create-new-virtual-transactions-admin-18507474e0.md?nav=01JYP3J8B9HRFJDB3H462K3GCK): Allows an administrator to create transactions between users, or between a user and the system. Multiple transaction requests can be batched. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries. - Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18468608e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - ActivityLogs [Create activity log](https://saas.aworld.org/create-activity-log-18468609e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Records a user's activity completion by creating a new activity log entry with an auto-generated ID - ActivityLogs [Create/update activity log](https://saas.aworld.org/createupdate-activity-log-18468610e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Records a user's activity completion by creating or updating an activity log entry with the provided ID. This endpoint is useful for idempotent operations when you need to ensure the same activity completion is not recorded multiple times. - Quizzes [List quizzes](https://saas.aworld.org/list-quizzes-18468611e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a paginated list of available quizzes for the authenticated user - Quizzes [Get quiz](https://saas.aworld.org/get-quiz-18468612e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a quiz object with associated content, excluding the correct answer for client-side display purposes. - Quizzes [Get quiz translation](https://saas.aworld.org/get-quiz-translation-18468613e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves the translation content for a specific quiz, including questions and answer options - VirtualBalances [List virtual balances](https://saas.aworld.org/list-virtual-balances-18468614e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a paginated list of virtual currency balances for the authenticated user. - VirtualBalances [Get virtual balance](https://saas.aworld.org/get-virtual-balance-18468615e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves the balance for a specific virtual currency for the authenticated user. - VirtualTransactions [List virtual transactions](https://saas.aworld.org/list-virtual-transactions-18468616e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a paginated list of virtual transactions for the authenticated user. - VirtualTransactions [Create virtual transactions](https://saas.aworld.org/create-virtual-transactions-18468617e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Allows a user to send virtual currency to another user. Multiple transaction requests can be batched. The source user is always the authenticated caller. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries. - VirtualTransactions [Get virtual transaction](https://saas.aworld.org/get-virtual-transaction-18468618e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a specific virtual transaction by its ID for the authenticated user. - VirtualTransactions [Redeem virtual transaction](https://saas.aworld.org/redeem-virtual-transaction-18468619e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Redeems a specific pending credit virtual transaction for the authenticated user. This action is typically available for transactions with 'MANUAL' redemption mode. Redeeming a transaction may also complete other related transactions (e.g., a corresponding debit) if they share the same redemptionGroupId. - Missions [List user's missions](https://saas.aworld.org/list-users-missions-18468620e0.md?nav=01JYP3CRYRVHBFJZRDDSQ01Y5X): Retrieves a paginated list of missions assigned to the authenticated user. - Authentication [Get OAuth2 Access Token](https://saas.aworld.org/get-oauth2-access-token-18507512e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Obtain an access token using OAuth2 Client Credentials flow. Use the returned access_token as Bearer token in the Authorization header for all API requests. - Activity [List activities](https://saas.aworld.org/list-activities-18507450e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of activities available in the workspace - Activity [Get activity by ID](https://saas.aworld.org/get-activity-by-id-18507451e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific activity by its unique identifier - Activity [Create activity](https://saas.aworld.org/create-activity-18507452e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new activity with the specified ID. It is recommended to use a human-readable ID. - Activity [Update activity](https://saas.aworld.org/update-activity-18507453e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing activity identified by its ID - Activity [Publish an activity](https://saas.aworld.org/publish-an-activity-18507454e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes an activity, making it available for use in the application - Missions [List missions](https://saas.aworld.org/list-missions-18507475e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of missions available in the workspace. - Missions [Create mission](https://saas.aworld.org/create-mission-18507476e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new mission with a system-generated ID. - Missions [Get mission by ID](https://saas.aworld.org/get-mission-by-id-18507477e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific mission by its unique identifier. - Missions [Update mission](https://saas.aworld.org/update-mission-18507478e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing mission identified by its ID. - Missions [Publish a mission](https://saas.aworld.org/publish-a-mission-18507479e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes a mission, making it available for use. - MissionRules [List mission rules](https://saas.aworld.org/list-mission-rules-18507480e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of mission rules available in the workspace. - MissionRules [Create mission rule](https://saas.aworld.org/create-mission-rule-18507481e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new mission rule with a system-generated ID. - MissionRules [Get mission rule by ID](https://saas.aworld.org/get-mission-rule-by-id-18507482e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific mission rule by its unique identifier. - MissionRules [Update mission rule](https://saas.aworld.org/update-mission-rule-18507483e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing mission rule identified by its ID. - MissionRules [Publish a mission rule](https://saas.aworld.org/publish-a-mission-rule-18507484e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes a mission rule, making it active. - MissionAssignments [Create mission assignment (manual)](https://saas.aworld.org/create-mission-assignment-manual-18507485e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Manually assigns a mission to a user or a group. This is typically used for specific cases not covered by mission rules. - RewardRules [List reward rules](https://saas.aworld.org/list-reward-rules-18507460e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of reward rules available in the workspace - RewardRules [Create reward rule](https://saas.aworld.org/create-reward-rule-18507461e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new reward rule with a system-generated ID - RewardRules [Get reward rule by ID](https://saas.aworld.org/get-reward-rule-by-id-18507462e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific reward rule by its unique identifier - RewardRules [Update reward rule](https://saas.aworld.org/update-reward-rule-18507463e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing reward rule identified by its ID - RewardRules [Publish a reward rule](https://saas.aworld.org/publish-a-reward-rule-18507464e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes a reward rule, making it available for use in the application - Tags [List tags](https://saas.aworld.org/list-tags-18507465e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of tags available in the workspace - Tags [Create tag](https://saas.aworld.org/create-tag-18507466e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new tag with a system-generated ID - Tags [Get tag by ID](https://saas.aworld.org/get-tag-by-id-18507467e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific tag by its unique identifier - Tags [Update tag](https://saas.aworld.org/update-tag-18507468e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing tag identified by its ID - Tags [Publish a tag](https://saas.aworld.org/publish-a-tag-18507469e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes a tag, making it available for use in the application - Users [List users](https://saas.aworld.org/list-users-18507470e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of users available in the workspace - Users [Create user](https://saas.aworld.org/create-user-18507471e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new user in the system with generated credentials - Users [Get user by ID](https://saas.aworld.org/get-user-by-id-18507472e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific user by their unique identifier - Users [Get user by external ID](https://saas.aworld.org/get-user-by-external-id-18507473e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific user by their unique external ID identifier - VirtualCurrencies [List virtual currencies](https://saas.aworld.org/list-virtual-currencies-18507455e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a paginated list of virtual currencies available in the workspace - VirtualCurrencies [Get virtual currency by ID](https://saas.aworld.org/get-virtual-currency-by-id-18507456e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Retrieves a specific virtual currency by its unique identifier - VirtualCurrencies [Create virtual currency](https://saas.aworld.org/create-virtual-currency-18507457e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Creates a new virtual currency with the specified ID. It is recommended to use a human-readable ID. - VirtualCurrencies [Update virtual currency](https://saas.aworld.org/update-virtual-currency-18507458e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Updates an existing virtual currency identified by its ID - VirtualCurrencies [Publish virtual currency](https://saas.aworld.org/publish-virtual-currency-18507459e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Publishes a virtual currency, making it available for use in the application - VirtualTransactions [Create new virtual transactions (Admin)](https://saas.aworld.org/create-new-virtual-transactions-admin-18507474e0.md?nav=01JYP3D5QEDJYK37FNC23C0GS4): Allows an administrator to create transactions between users, or between a user and the system. Multiple transaction requests can be batched. Operations are atomic (all or nothing). It is strongly recommended to include an 'X-Idempotency-Key' header for safe retries.