Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
Roblox API (openapi)
The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.
Download the original OpenAPI definition
Operations
| Method | Endpoint | Summary |
|---|---|---|
| GET | /ads-management/v1/advertisable-universes | List advertisable universes |
| GET | /ads-management/v1/billing-accounts | List billing accounts |
| GET | /ads-management/v1/billing-accounts/{id} | Get a billing account |
| GET | /ads-management/v1/campaign-options | Get campaign options |
| GET | /ads-management/v1/campaigns | List campaigns |
| POST | /ads-management/v1/campaigns | Create a campaign |
| GET | /ads-management/v1/campaigns/{id} | Get a campaign |
| PATCH | /ads-management/v1/campaigns/{id} | Update a campaign |
| POST | /ads-management/v1/campaigns:batchGetStatus | Batch get campaign status |
| GET | /ads-management/v1/creatives | List creatives |
| POST | /analytics-query-api/v1/universes/{universeId}/dimension-values | Queries dimension values for a universe. |
| POST | /analytics-query-api/v1/universes/{universeId}/metrics | Queries time series metric data for a universe. |
| GET | /analytics-query-api/v1/universes/{universeId}/operations/dimension-values/{operationId} | Retrieves the result of a long-running dimension values operation. |
| GET | /analytics-query-api/v1/universes/{universeId}/operations/metrics/{operationId} | Retrieves the result of a long-running metrics query operation. |
| PATCH | /asset-permissions-api/v1/assets/permissions | Grant a subject permission to multiple assets. Authorization is required to grant permissions to the subject and asset IDs in the request. |
| POST | /assets/v1/assets | Creates an asset with provided content and metadata. |
| GET | /assets/v1/assets/{assetId} | Retrieve specific asset metadata. Include the readMask parameter for additional asset metadata. |
| PATCH | /assets/v1/assets/{assetId} | Updates an asset with provided content and metadata. |
| GET | /assets/v1/assets/{assetId}/versions | List Asset Versions of an Asset |
| GET | /assets/v1/assets/{assetId}/versions/{versionNumber} | Get Asset Version |
| POST | /assets/v1/assets/{assetId}/versions:rollback | Rollback an asset to a previous version. |
| POST | /assets/v1/assets/{assetId}:archive | Archives the asset. |
| POST | /assets/v1/assets/{assetId}:restore | Restores an archived asset. |
| GET | /assets/v1/operations/{operationId} | Get the result of an asset creation or update. |
| POST | /cloud/v2/creator-store-products | Create Creator Store Product |
| GET | /cloud/v2/creator-store-products/{creator_store_product_id} | Get Creator Store Product |
| PATCH | /cloud/v2/creator-store-products/{creator_store_product_id} | Update Creator Store Product |
| GET | /cloud/v2/groups/{group_id} | Get Group |
| GET | /cloud/v2/groups/{group_id}/forum-categories | List Group Forum Categories |
| GET | /cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/posts | List Group Forum Posts |
| GET | /cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/posts/{post_id}/comments | List Group Forum Comments |
| GET | /cloud/v2/groups/{group_id}/join-requests | List Group Join Requests |
| POST | /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:accept | Accept Group Join Request |
| POST | /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:decline | Decline Group Join Request |
| GET | /cloud/v2/groups/{group_id}/memberships | List Group Memberships |
| PATCH | /cloud/v2/groups/{group_id}/memberships/{membership_id} | Update Group Membership |
| POST | /cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRole | Assign Role Group Membership |
| POST | /cloud/v2/groups/{group_id}/memberships/{membership_id}:unassignRole | Unassign Role Group Membership |
| GET | /cloud/v2/groups/{group_id}/roles | List Group Roles |
| GET | /cloud/v2/groups/{group_id}/roles/{role_id} | Get Group Role |
| GET | /cloud/v2/universes/{universeId}/secrets | List Secrets |
| POST | /cloud/v2/universes/{universeId}/secrets | Create Secret |
| GET | /cloud/v2/universes/{universeId}/secrets/public-key | Get Public Key |
| DELETE | /cloud/v2/universes/{universeId}/secrets/{secretId} | Delete Secret |
| PATCH | /cloud/v2/universes/{universeId}/secrets/{secretId} | Update Secret |
| GET | /cloud/v2/universes/{universe_id} | Get Universe |
| PATCH | /cloud/v2/universes/{universe_id} | Update Universe |
| GET | /cloud/v2/universes/{universe_id}/data-stores | List Data Stores |
| DELETE | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id} | Delete Data Store |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries | List Data Store Entries |
| POST | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries | Create Data Store Entry |
| DELETE | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id} | Delete Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id} | Get Data Store Entry |
| PATCH | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id} | Update Data Store Entry |
| POST | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment | Increment Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions | List Data Store Entry Revisions |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries | List Data Store Entries |
| POST | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries | Create Data Store Entry |
| DELETE | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id} | Delete Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id} | Get Data Store Entry |
| PATCH | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id} | Update Data Store Entry |
| POST | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment | Increment Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:listRevisions | List Data Store Entry Revisions |
| POST | /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}:undelete | Undelete Data Store |
| POST | /cloud/v2/universes/{universe_id}/data-stores:snapshot | Snapshot Data Stores |
| POST | /cloud/v2/universes/{universe_id}/luau-execution-session-task-binary-inputs | Create Luau Execution Session Task Binary Input |
| GET | /cloud/v2/universes/{universe_id}/memory-store/operations/{operation_id} | Get Memory Store Flush Operation |
| POST | /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items | Create Memory Store Queue Item |
| POST | /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:discard | Discard Memory Store Queue Items |
| GET | /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read | Read Memory Store Queue Items |
| GET | /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items | List Memory Store Sorted Map Items |
| POST | /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items | Create Memory Store Sorted Map Item |
| DELETE | /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id} | Delete Memory Store Sorted Map Item |
| GET | /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id} | Get Memory Store Sorted Map Item |
| PATCH | /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id} | Update Memory Store Sorted Map Item |
| POST | /cloud/v2/universes/{universe_id}/memory-store:flush | Flush Memory Store |
| GET | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries | List Ordered Data Store Entries |
| POST | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries | Create Ordered Data Store Entry |
| DELETE | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id} | Delete Ordered Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id} | Get Ordered Data Store Entry |
| PATCH | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id} | Update Ordered Data Store Entry |
| POST | /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment | Increment Ordered Data Store Entry |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id} | Get Place |
| PATCH | /cloud/v2/universes/{universe_id}/places/{place_id} | Update Place |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id} | Get Instance |
| PATCH | /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id} | Update Instance |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}/operations/{operation_id} | Get Update Instance Operation |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren | List Instance Children |
| POST | /cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks | Create Luau Execution Session Task |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions | List User Restrictions |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id} | Get User Restriction |
| PATCH | /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id} | Update User Restriction |
| POST | /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-session-tasks | Create Luau Execution Session Task |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_id} | Get Luau Execution Session Task |
| GET | /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_id}/logs | List Luau Execution Session Task Logs |
| GET | /cloud/v2/universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id} | Get Subscription |
| GET | /cloud/v2/universes/{universe_id}/user-restrictions | List User Restrictions |
| GET | /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id} | Get User Restriction |
| PATCH | /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id} | Update User Restriction |
| GET | /cloud/v2/universes/{universe_id}/user-restrictions:listLogs | List User Restriction Logs |
| POST | /cloud/v2/universes/{universe_id}:generateSpeechAsset | Generate Speech Asset |
| POST | /cloud/v2/universes/{universe_id}:publishMessage | Publish Universe Message |
| POST | /cloud/v2/universes/{universe_id}:restartServers | Restart Universe Servers |
| POST | /cloud/v2/universes/{universe_id}:translateText | Translate Text |
| GET | /cloud/v2/users/{user_id} | Get User |
| GET | /cloud/v2/users/{user_id}/asset-quotas | List Asset Quotas |
| GET | /cloud/v2/users/{user_id}/inventory-items | List Inventory Items |
| POST | /cloud/v2/users/{user_id}/notifications | Create User Notification |
| GET | /cloud/v2/users/{user_id}/operations/{operation_id} | Get User Thumbnail Generation Operation |
| GET | /cloud/v2/users/{user_id}:generateThumbnail | Generate User Thumbnail |
| GET | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository} | Gets published config values without metadata. |
| DELETE | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/draft | Resets (deletes) the current draft. |
| GET | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/draft | Gets the current draft. |
| PATCH | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/draft | Partially updates the draft. |
| PUT | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/draft:overwrite | Overwrites the entire draft with the request payload. |
| GET | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/full | Gets full config with metadata. |
| POST | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/publish | Publishes draft changes. |
| GET | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/revisions | Lists revision history. |
| POST | /creator-configs-public-api/v1/configs/universes/{universeId}/repositories/{repository}/revisions/{revisionId}/restore | Stages a revert to a previous revision. |
| GET | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments | Lists experiments for a universe. |
| POST | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments | Creates a new experiment for a universe. |
| DELETE | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId} | Discards an experiment. |
| GET | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId} | Gets an experiment by ID. |
| PATCH | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId} | Updates an existing experiment. |
| GET | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}/stats | Gets diagnostic stats for an experiment. |
| POST | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete | Completes an experiment by stopping it and rolling out the requested variant. |
| POST | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:schedule | Schedules an experiment to start at a future UTC time. |
| POST | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:start | Starts an experiment immediately. |
| POST | /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments:calculateMde | Calculates the Minimum Detectable Effect (MDE) for a prospective experiment. |
| GET | /creator-configs-public-api/v1/experimentation/universes/{universeId}/operations/{operationId} | Gets the status of an experiment async operation. |
| GET | /datastores/v1/universes/{universeId}/standard-datastores | List data stores in an experience |
| GET | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries | List entries |
| DELETE | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry | Delete entry. |
| GET | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry | Get entry. |
| POST | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry | Set entry. |
| POST | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment | Increment entry |
| GET | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions | List entry versions |
| GET | /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version | Get entry version. |
| POST | /developer-products/v2/universes/{universeId}/developer-products | Create developer product |
| GET | /developer-products/v2/universes/{universeId}/developer-products/creator | List developer products by universe with configuration details |
| PATCH | /developer-products/v2/universes/{universeId}/developer-products/{productId} | Update developer product |
| GET | /developer-products/v2/universes/{universeId}/developer-products/{productId}/creator | Get developer product with configuration details |
| POST | /game-passes/v1/universes/{universeId}/game-passes | Create game pass |
| GET | /game-passes/v1/universes/{universeId}/game-passes/creator | List game passes by universe with configuration details |
| PATCH | /game-passes/v1/universes/{universeId}/game-passes/{gamePassId} | Update game pass |
| GET | /game-passes/v1/universes/{universeId}/game-passes/{gamePassId}/creator | Get game pass with configuration details |
| PATCH | /legacy-badges/v1/badges/{badgeId} | Updates badge configuration. |
| POST | /legacy-badges/v1/universes/{universeId}/badges | Creates a new badge. |
| GET | /legacy-develop/v1/places/{placeId}/teamcreate/active_session/members | List of users in the active Team Create session |
| GET | /legacy-develop/v1/universes/multiget/permissions | Returns an array of granted and declined permissions related to the universes with the ids in ids for the authenticated user. |
| GET | /legacy-develop/v1/universes/multiget/teamcreate | Gets TeamCreate settings for multiple universes specified by Ids |
| POST | /legacy-develop/v1/universes/{universeId}/activate | Activates a universes. |
| POST | /legacy-develop/v1/universes/{universeId}/deactivate | Deactivates a universe. |
| GET | /legacy-develop/v1/universes/{universeId}/permissions | Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user |
| GET | /legacy-develop/v1/universes/{universeId}/teamcreate | Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse. |
| PATCH | /legacy-develop/v1/universes/{universeId}/teamcreate | Edit team create settings for a universe. |
| DELETE | /legacy-develop/v1/universes/{universeId}/teamcreate/memberships | Removes a user from a TeamCreate permissions list. |
| GET | /legacy-develop/v1/user/groups/canmanage | Gets a list of Groups that a user can manage. |
| DELETE | /legacy-develop/v2/teamtest/{placeId} | Close a game instance that is being used for team testing |
| GET | /legacy-followings/v1/users/{userId}/universes | Gets all the followings between a user with userId and universes |
| DELETE | /legacy-followings/v1/users/{userId}/universes/{universeId} | Deletes the following between a user with userId and universe with universeId |
| POST | /legacy-followings/v1/users/{userId}/universes/{universeId} | Creates the following between a user with userId and universe with universeId |
| GET | /legacy-followings/v1/users/{userId}/universes/{universeId}/status | Gets the status of a following relationship between a user and a universe. |
| GET | /legacy-followings/v2/users/{userId}/universes | Gets all universes followed by a user. |
| PATCH | /legacy-game-internationalization/v1/badges/{badgeId}/description/language-codes/{languageCode} | Update localized description of a badge |
| GET | /legacy-game-internationalization/v1/badges/{badgeId}/icons | Get all icons for a badge |
| DELETE | /legacy-game-internationalization/v1/badges/{badgeId}/icons/language-codes/{languageCode} | Delete a localized icon from a badge |
| POST | /legacy-game-internationalization/v1/badges/{badgeId}/icons/language-codes/{languageCode} | Update a badge's icon |
| GET | /legacy-game-internationalization/v1/badges/{badgeId}/name-description | |
| DELETE | /legacy-game-internationalization/v1/badges/{badgeId}/name-description/language-codes/{languageCode} | Delete localized name and description of a badge |
| PATCH | /legacy-game-internationalization/v1/badges/{badgeId}/name-description/language-codes/{languageCode} | Update localized name and description of a badge |
| PATCH | /legacy-game-internationalization/v1/badges/{badgeId}/name/language-codes/{languageCode} | Update localized name of a badge |
| PATCH | /legacy-game-internationalization/v1/developer-products/{developerProductId}/description/language-codes/{languageCode} | Update localized description of a developer product |
| GET | /legacy-game-internationalization/v1/developer-products/{developerProductId}/icons | Get all icons for a developer product |
| DELETE | /legacy-game-internationalization/v1/developer-products/{developerProductId}/icons/language-codes/{languageCode} | Delete a localized icon from a developer product |
| POST | /legacy-game-internationalization/v1/developer-products/{developerProductId}/icons/language-codes/{languageCode} | Update a developer product's icon |
| GET | /legacy-game-internationalization/v1/developer-products/{developerProductId}/name-description | Get all names and descriptions of a developer product |
| DELETE | /legacy-game-internationalization/v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode} | Delete localized name and description of a developer product |
| PATCH | /legacy-game-internationalization/v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode} | Update localized name and description of a developer product |
| PATCH | /legacy-game-internationalization/v1/developer-products/{developerProductId}/name/language-codes/{languageCode} | Update localized name of a developer product |
| GET | /legacy-game-internationalization/v1/game-icon/games/{gameId} | Get all icons for a game |
| DELETE | /legacy-game-internationalization/v1/game-icon/games/{gameId}/language-codes/{languageCode} | Delete a localized icon from a game |
| POST | /legacy-game-internationalization/v1/game-icon/games/{gameId}/language-codes/{languageCode} | Update a game's icon |
| PATCH | /legacy-game-internationalization/v1/game-passes/{gamePassId}/description/language-codes/{languageCode} | Update localized description of a game pass |
| GET | /legacy-game-internationalization/v1/game-passes/{gamePassId}/icons | Get all icons for a game pass |
| DELETE | /legacy-game-internationalization/v1/game-passes/{gamePassId}/icons/language-codes/{languageCode} | Delete a localized icon from a game pass |
| POST | /legacy-game-internationalization/v1/game-passes/{gamePassId}/icons/language-codes/{languageCode} | Update a game pass's icon |
| GET | /legacy-game-internationalization/v1/game-passes/{gamePassId}/name-description | Get all names and descriptions of a game pass |
| DELETE | /legacy-game-internationalization/v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode} | Delete localized name and description of a game pass |
| PATCH | /legacy-game-internationalization/v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode} | Update localized name and description of a game pass |
| PATCH | /legacy-game-internationalization/v1/game-passes/{gamePassId}/name/language-codes/{languageCode} | Update localized name of a game pass |
| POST | /legacy-game-internationalization/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/alt-text | Updates the game thumbnail alt text. |
| POST | /legacy-game-internationalization/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/image | Uploads the game thumbnail. |
| POST | /legacy-game-internationalization/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/order | Orders the specified image Ids for the game thumbnails. |
| DELETE | /legacy-game-internationalization/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/{imageId} | Deletes the game thumbnail. |
| POST | /legacy-game-internationalization/v1/name-description/games/translation-history | Gets the history for name or description in a provided language. |
| PATCH | /legacy-game-internationalization/v1/name-description/games/{gameId} | Updates a game's name and/or description in multiple languages. |
| PATCH | /legacy-game-internationalization/v1/source-language/games/{gameId} | Sets the source language of a game |
| PATCH | /legacy-game-internationalization/v1/supported-languages/games/{gameId} | Add or remove supported languages for a game. |
| GET | /legacy-game-internationalization/v1/supported-languages/games/{gameId}/automatic-translation-status | Get the automatic translation status of supported languages for a game. |
| PATCH | /legacy-game-internationalization/v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status | Enable or disable automatic translation for a game and language. |
| PATCH | /legacy-game-internationalization/v1/supported-languages/games/{gameId}/languages/{languageCode}/image-translation-status | Enable or disable image translation for a game and language. |
| PATCH | /legacy-game-internationalization/v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings | Update the switch which controls if the UniverseDisplayInformation should be automatically translated. |
| GET | /legacy-game-internationalization/v1/supported-languages/games/{gameId}/universe-display-info-automatic-translation-settings | Get UniverseDisplayInfo automatic translation settings. |
| POST | /legacy-localization-tables/v1/autolocalization/games/{gameId}/autolocalizationtable | |
| PATCH | /legacy-localization-tables/v1/autolocalization/games/{gameId}/settings | Sets a game's auto-localization related settings |
| GET | /legacy-localization-tables/v1/autolocalization/metadata | Metadata for AutoLocalization Configuration |
| GET | /legacy-localization-tables/v1/localization-table/limits | Get limits for translation table entries operations |
| GET | /legacy-localization-tables/v1/localization-table/tables/{assetId} | Get table information by the assetId of the table. |
| GET | /legacy-localization-tables/v1/localization-table/tables/{tableId} | Get table information by the id of the table. |
| PATCH | /legacy-localization-tables/v1/localization-table/tables/{tableId} | Updates the tables contents based on what is provided. |
| GET | /legacy-localization-tables/v1/localization-table/tables/{tableId}/entries | Gets a batch of entries for a table. |
| POST | /legacy-localization-tables/v1/localization-table/tables/{tableId}/entries/translation-history | Gets the translation history for each entry passed in. |
| GET | /legacy-localization-tables/v1/localization-table/tables/{tableId}/entry-count | Gets the number of entries in the specified table |
| POST | /legacy-publish/v1/badges/{badgeId}/icon | Overwrites a badge icon with a new one. |
| GET | /matchmaking-api/v1/client-status | Get the client-status |
| POST | /matchmaking-api/v1/client-status | Set the client-status |
| POST | /matchmaking-api/v1/game-instances/forecast-update | Forecast the outcome of launching an update |
| GET | /matchmaking-api/v1/game-instances/get-update-status | Get the rollout status of an update |
| POST | /matchmaking-api/v1/game-instances/launch-update | Launch a game update |
| POST | /matchmaking-api/v1/game-instances/shutdown | Shutdown game instances. |
| POST | /matchmaking-api/v1/game-instances/shutdown-all | Shutdown all game instances. |
| POST | /matchmaking-api/v1/matchmaking/player-attribute | Create a PlayerAttributeDefinition. |
| DELETE | /matchmaking-api/v1/matchmaking/player-attribute/{attributeId} | Delete the PlayerAttributeDefinition specified by attributeId. |
| PATCH | /matchmaking-api/v1/matchmaking/player-attribute/{attributeId} | Update the PlayerAttributeDefinition specified by attributeId. |
| GET | /matchmaking-api/v1/matchmaking/player-attributes/{universeId} | List all PlayerAttributeDefinitions of a universe. |
| POST | /matchmaking-api/v1/matchmaking/scoring-configuration | Creates a matchmaking scoring configuration. |
| GET | /matchmaking-api/v1/matchmaking/scoring-configuration/default-weights | |
| GET | /matchmaking-api/v1/matchmaking/scoring-configuration/generate-mock-servers | |
| POST | /matchmaking-api/v1/matchmaking/scoring-configuration/place | Sets a matchmaking scoring configuration for a place. |
| DELETE | /matchmaking-api/v1/matchmaking/scoring-configuration/place/{placeId} | Removes the matchmaking scoring configuration for a place. |
| DELETE | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId} | Deletes a matchmaking scoring configuration. |
| GET | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId} | Updates a matchmaking scoring configuration. |
| PATCH | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId} | Updates a matchmaking scoring configuration. |
| POST | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId}/signals | Creates a matchmaking scoring configuration signal. |
| DELETE | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId}/signals/{signalName} | Deletes a matchmaking scoring configuration custom signal. |
| PATCH | /matchmaking-api/v1/matchmaking/scoring-configuration/{scoringConfigurationId}/signals/{signalName} | Updates a matchmaking scoring configuration signal. |
| GET | /matchmaking-api/v1/matchmaking/scoring-configurations/{universeId} | List all matchmaking scoring configurations for a universe. |
| GET | /matchmaking-api/v1/matchmaking/scoring-configurations/{universeId}/places | List all places with a matchmaking scoring configuration for a universe. |
| POST | /matchmaking-api/v1/matchmaking/server-attribute | Create a ServerAttributeDefinition. |
| DELETE | /matchmaking-api/v1/matchmaking/server-attribute/{attributeId} | Delete the ServerAttributeDefinition specified by attributeId. |
| PATCH | /matchmaking-api/v1/matchmaking/server-attribute/{attributeId} | Update the ServerAttributeDefinition specified by attributeId. |
| GET | /matchmaking-api/v1/matchmaking/server-attributes/{universeId} | List all ServerAttributeDefinitions of a universe. |
| GET | /matchmaking-api/v1/matchmaking/universe/{universeId}/feature-flags | Gets feature flags for a customized matchmaking for a given universe. |
| DELETE | /matchmaking-api/v1/matchmaking/universe/{universeId}/start-place | Deletes the start place override for a universe. |
| GET | /matchmaking-api/v1/matchmaking/universe/{universeId}/start-place | Gets the start place override for a universe. |
| POST | /matchmaking-api/v1/matchmaking/universe/{universeId}/start-place | Sets (creates or updates) the start place override for a universe. |
| POST | /messaging-service/v1/universes/{universeId}/topics/{topic} | Publish a cross-server message to a universe |
| GET | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries | |
| POST | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries | |
| DELETE | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry} | |
| GET | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry} | |
| PATCH | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry} | |
| POST | /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment | |
| GET | /place-version-history-api/v1/{placeId}/contributors | Endpoint used to fetch all previous contributors of a place. |
| GET | /place-version-history-api/v1/{placeId}/history | Endpoint used to get place versions, using various filters |
| POST | /place-version-history-api/v1/{placeId}/version/{version}/notes | Endpoint used to modify the notes of a particular version for a place. |
| GET | /server-management/v1/universes/{universeId}/places/{placeId}/game-servers:filter-options | Gets available filter options for game servers. |
| GET | /server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers | Lists game servers for a specific place version. |
| GET | /server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers/{jobId}/logs | Lists game server logs for a specific server job id |
| GET | /server-management/v1/universes/{universeId}/restarts | List restart statuses for a universe. |
| POST | /server-management/v1/universes/{universeId}/restarts | Launch a game server restart for a universe. |
| GET | /server-management/v1/universes/{universeId}/restarts:forecast | Forecast the impact of restarting game servers for a universe. |
| GET | /thumbnail-personalization-api/v1/universes/{universeId}/personalization | Gets a page of thumbnail personalization configurations for a universe. |
| POST | /thumbnail-personalization-api/v1/universes/{universeId}/personalization/create | Creates a new active thumbnail personalization configuration for a universe. This deactivates the current active configuration, and the new configuration starts its own statistics. |
| POST | /thumbnail-personalization-api/v1/universes/{universeId}/personalization/update | Replaces the homepage thumbnails in an active personalization configuration without changing its identifier or existing statistics. |
| DELETE | /thumbnail-personalization-api/v1/universes/{universeId}/thumbnails | Deletes homepage thumbnails from a universe. |
| GET | /thumbnail-personalization-api/v1/universes/{universeId}/thumbnails | Gets a page of homepage thumbnails for a universe. |
| POST | /thumbnail-personalization-api/v1/universes/{universeId}/thumbnails/uploads | Uploads one or more images to create homepage thumbnails for a universe. |
| GET | /thumbnail-personalization-api/v1/universes/{universeId}/thumbnails/uploads/status | Gets the processing status of homepage thumbnail upload operations. |
| DELETE | /toolbox-service/v1/saves | Deletes a save. |
| GET | /toolbox-service/v1/saves | Gets saves from a collection. |
| POST | /toolbox-service/v1/saves | Creates a save. |
| POST | /toolbox-service/v1/saves:bulkDelete | Bulk deletes saves. Max of 5000 saves per request. |
| GET | /toolbox-service/v2/assets/{id} | Get Creator Store Asset Details |
| GET | /toolbox-service/v2/assets:search | Search Creator Store Assets |
| POST | /toolbox-service/v2/assets:search | Search Creator Store Assets |
| POST | /universes/v1/{universeId}/places/{placeId}/versions | |
| GET | /v1/account-creation/metadata | Get metadata for adding auth methods. |
| DELETE | /v1/account/pin | Request for deletes the account pin from the account. |
| GET | /v1/account/pin | Gets the account pin status. |
| PATCH | /v1/account/pin | Request made to update the account pin on the account. |
| POST | /v1/account/pin | Request to create the account pin. |
| POST | /v1/account/pin/lock | Request to locks the account which has an account pin enabled. |
| POST | /v1/account/pin/unlock | Requests to unlock the account pin. |
| POST | /v1/account/upgrade | Attaches a sign-in credential to the calling account. |
| GET | /v1/announcements | Migrate from RobloxWebsite project, return news notification for Private Message page |
| GET | /v1/announcements/metadata | |
| GET | /v1/asset | |
| GET | /v1/asset-thumbnail-animated | Thumbnails asset animated. |
| GET | /v1/assetId/{assetId} | Retrieves an asset by its ID |
| GET | /v1/assetId/{assetId}/version/{versionNumber} | Retrieves an asset by its ID and version number. |
| GET | /v1/assets#thumbnails.roblox.com | Thumbnails assets. |
| GET | /v1/assets-thumbnail-3d | Thumbnails assets. |
| POST | /v1/assets/batch | |
| GET | /v1/assets/{assetId}/bundles | Lists the bundles a particular asset belongs to. Use the Id of the last bundle in the response to get the next page. |
| GET | /v1/auth/metadata | Gets Auth meta data |
| POST | /v1/auto-localization-table/games/{gameId}/assets-generation-request | Generates localization asset of a game. |
| POST | /v1/auto-localization-table/games/{gameId}/auto-scrape-cleanup-request | Enqueues an event to flush the auto scraped entries which doesn't have translations. |
| PATCH | /v1/autolocalization/games/{gameId}/autolocalizationtable#localizationtables.roblox.com | |
| POST | /v1/autolocalization/games/{gameId}/autolocalizationtable#localizationtables.roblox.com | |
| PATCH | /v1/autolocalization/games/{gameId}/settings#localizationtables.roblox.com | Sets a game's auto-localization related settings |
| GET | /v1/autolocalization/metadata#localizationtables.roblox.com | Metadata for AutoLocalization Configuration |
| GET | /v1/automatic-translation/games/{gameId}/feature-status | Checks if automatic translation can be enabled for a game. The user must still have proper permissions for the game to get this info. |
| GET | /v1/automatic-translation/games/{gameId}/quota | Returns the automatic translation quota info for a game. The user must still have proper permissions for the game to get this info. |
| GET | /v1/automatic-translation/languages/{languageCode}/target-languages | Checks if the requested target languages are allowed for automatic translation based on the source language. If there are no requested target languages, then all allowed target languages for the source language will be returned. |
| GET | /v1/avatar | Returns details about the authenticated user's avatar. |
| GET | /v1/avatar-rules | Returns the business rules related to avatars. |
| GET | /v1/avatar/metadata | Returns metadata used by the avatar page of the website. |
| POST | /v1/avatar/redraw-thumbnail | Requests the authenticated user's thumbnail be redrawn. |
| POST | /v1/avatar/set-body-colors | Sets the authenticated user's body colors. |
| POST | /v1/avatar/set-player-avatar-type | Sets the authenticated user's player avatar type (e.g. R6 or R15). |
| POST | /v1/avatar/set-scales | Sets the authenticated user's scales. |
| GET | /v1/badges/icons | Thumbnails badge icons. |
| GET | /v1/badges/metadata | Gets metadata about the badges system. |
| GET | /v1/badges/{badgeId} | Gets badge information by the badge Id. |
| PATCH | /v1/badges/{badgeId} | Updates badge configuration. |
| PATCH | /v1/badges/{badgeId}/description/language-codes/{languageCode} | Update localized description of a badge |
| POST | /v1/badges/{badgeId}/icon#publish.roblox.com | Overwrites a badge icon with a new one. |
| GET | /v1/badges/{badgeId}/icons | Get all icons for a badge |
| DELETE | /v1/badges/{badgeId}/icons/language-codes/{languageCode} | Delete a localized icon from a badge |
| POST | /v1/badges/{badgeId}/icons/language-codes/{languageCode} | Update a badge's icon |
| GET | /v1/badges/{badgeId}/name-description | |
| DELETE | /v1/badges/{badgeId}/name-description/language-codes/{languageCode} | Delete localized name and description of a badge |
| PATCH | /v1/badges/{badgeId}/name-description/language-codes/{languageCode} | Update localized name and description of a badge |
| PATCH | /v1/badges/{badgeId}/name/language-codes/{languageCode} | Update localized name of a badge |
| POST | /v1/batch | Returns a list of thumbnails with varying types and sizes |
| GET | /v1/birthdate | Get the user's birthdate |
| POST | /v1/birthdate | Update the user's birthdate |
| GET | /v1/birthdate#users.roblox.com | Get the user's birthdate |
| GET | /v1/bundles/details | Returns details about the given bundleIds. |
| GET | /v1/bundles/thumbnails | Get bundle thumbnails for the given CSV of bundle ids |
| GET | /v1/bundles/{bundleId}/details | Returns details about the given bundleId. |
| POST | /v1/catalog/items/details | Returns details for one or more catalog items. |
| GET | /v1/client-assertion | Creates a client assertion to be used when generating an auth ticket. |
| GET | /v1/client-version/{binaryType} | Get client version information for specific binary type |
| DELETE | /v1/collections/items/{itemType}/{itemTargetId} | Removes an item to the appropriate collection |
| POST | /v1/collections/items/{itemType}/{itemTargetId} | Adds an item to the appropriate collection |
| GET | /v1/country-regions | Get list of country regions sorted by localized name |
| GET | /v1/description | Get the user's description |
| POST | /v1/description | Update the user's description |
| GET | /v1/description#users.roblox.com | Get the user's description |
| POST | /v1/description#users.roblox.com | Update the user's description |
| GET | /v1/developer-products/icons | Thumbnails developer product icons. |
| PATCH | /v1/developer-products/{developerProductId}/description/language-codes/{languageCode} | Update localized description of a developer product |
| GET | /v1/developer-products/{developerProductId}/icons | Get all icons for a developer product |
| DELETE | /v1/developer-products/{developerProductId}/icons/language-codes/{languageCode} | Delete a localized icon from a developer product |
| POST | /v1/developer-products/{developerProductId}/icons/language-codes/{languageCode} | Update a developer product's icon |
| GET | /v1/developer-products/{developerProductId}/name-description | Get all names and descriptions of a developer product |
| DELETE | /v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode} | Delete localized name and description of a developer product |
| PATCH | /v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode} | Update localized name and description of a developer product |
| PATCH | /v1/developer-products/{developerProductId}/name/language-codes/{languageCode} | Update localized name of a developer product |
| GET | /v1/display-names/validate | Validate a display name for a new user. |
| POST | /v1/email/verify | Verify the user's email address from token |
| POST | /v1/external/access | Signs a user up for Roblox and links the account to the authenticated external provider ID. |
| POST | /v1/external/login | Logs in a user to Roblox based on the user's authenticated external provider session |
| POST | /v1/external/loginAndLink | Deprecated endpoint Logins in a user to Roblox, then links the Roblox account to the external provider ID |
| POST | /v1/external/signup | Signs a user up for Roblox and links the account to the authenticated external provider ID |
| POST | /v1/external/unlink | Unlink the logged in Roblox account from the current external provider ID |
| POST | /v1/external/{identityProviderId}/sso/native/nonce | Reserves a nonce for a native SSO sign-in attempt. |
| GET | /v1/external/{identityProviderId}/sso/oauth/callback | OAuth callback for identity providers that return the authorization code on a GET redirect (Okta, Google). |
| POST | /v1/external/{identityProviderId}/sso/oauth/callback | OAuth callback for identity providers that POST the authorization code as form fields (Apple form_post). Apple's first-auth user JSON is parsed and carried to identity storage; the form id_token is ignored. Web login exchanges code via PKCE and does not treat a form id_token as proof. |
| GET | /v1/external/{identityProviderId}/sso/oauth/init | Signs a user up for Roblox and links the account to the authenticated external provider ID via OAuth. |
| POST | /v1/external/{identityProviderId}/sso/saml/assertion-consumer-service | SAML Assertion Consumer Service endpoint that external identity provider calls post user authentication. |
| GET | /v1/favorites/assets/{assetId}/count | Gets the favorite count for the given asset Id. |
| GET | /v1/favorites/bundles/{bundleId}/count | Gets the favorite count for the given bundle Id. |
| GET | /v1/favorites/users/{userId}/favorites/{assetTypeId}/assets | Lists the marketplace assets favorited by a given user with the given assetTypeId. |
| GET | /v1/game-icon/games/{gameId} | Get all icons for a game |
| DELETE | /v1/game-icon/games/{gameId}/language-codes/{languageCode} | Delete a localized icon from a game |
| POST | /v1/game-icon/games/{gameId}/language-codes/{languageCode} | Update a game's icon |
| PATCH | /v1/game-localization-roles/games/{gameId} | Assigns or revokes a role |
| GET | /v1/game-localization-roles/games/{gameId}/current-user/roles | Retrieves the list of roles granted to current logged-in user |
| GET | /v1/game-localization-roles/games/{gameId}/roles/{role}/assignees | Gets list of users assigned a specific role in a game. |
| GET | /v1/game-localization-roles/roles/{role}/current-user | Gets the list of games and associated role assignment info for the requested user and role. |
| GET | /v1/game-localization-status/translation-counts-for-language-or-locale | Gets the language translation counts for the specified table. The languages to retrieve must be provided. |
| GET | /v1/game-localization-status/{gameId}/translation-counts | Gets the language translation counts for all languages of a game |
| GET | /v1/game-passes | Thumbnails game pass icons. |
| PATCH | /v1/game-passes/{gamePassId}/description/language-codes/{languageCode} | Update localized description of a game pass |
| GET | /v1/game-passes/{gamePassId}/icons | Get all icons for a game pass |
| DELETE | /v1/game-passes/{gamePassId}/icons/language-codes/{languageCode} | Delete a localized icon from a game pass |
| POST | /v1/game-passes/{gamePassId}/icons/language-codes/{languageCode} | Update a game pass's icon |
| GET | /v1/game-passes/{gamePassId}/name-description | Get all names and descriptions of a game pass |
| DELETE | /v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode} | Delete localized name and description of a game pass |
| PATCH | /v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode} | Update localized name and description of a game pass |
| PATCH | /v1/game-passes/{gamePassId}/name/language-codes/{languageCode} | Update localized name of a game pass |
| GET | /v1/game-start-info | The server will call this on game server start to request general information about the universe This is version 1.1, which returns an entry from the UniverseAvatarType enum. During mixed mode this may return unreliable results. |
| GET | /v1/game-thumbnails/games/{gameId}/images | Get the localized image ids in all languages for a game. |
| POST | /v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/alt-text | Updates the game thumbnail alt text. |
| POST | /v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/image | Uploads the game thumbnail. |
| POST | /v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/order | Orders the specified image Ids for the game thumbnails. |
| DELETE | /v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/{imageId} | Deletes the game thumbnail. |
| GET | /v1/games | Gets a list of games' detail |
| GET | /v1/games/games-product-info | Gets a list of games' product info, used to purchase a game |
| GET | /v1/games/icons | Fetches game icon URLs for a list of universes' root places. Ids that do not correspond to a valid universe will be filtered out. The ordering of the results is not guaranteed to be the same as the inputs. In order to correlated inputs with outputs please use the 'targetId' of the objects in the result array. |
| GET | /v1/games/multiget-place-details | Get place details |
| GET | /v1/games/multiget-playability-status | Gets a list of universe playability statuses for the authenticated user |
| GET | /v1/games/multiget/thumbnails | Fetch game thumbnail URLs for a list of universe IDs. |
| GET | /v1/games/recommendations/game/{universeId} | Get games recommendations based on a given universe |
| GET | /v1/games/votes | |
| GET | /v1/games/{placeId}/private-servers | |
| GET | /v1/games/{universeId}/favorites | Returns if a game was marked as favorite for the authenticated user |
| POST | /v1/games/{universeId}/favorites | Favors (or unfavors) a game for the authenticated user |
| GET | /v1/games/{universeId}/favorites/count | Get the favorites count of a specific game. |
| GET | /v1/games/{universeId}/thumbnails | Fetches game thumbnail URLs for a list of universes' thumbnail ids. Ids that do not correspond to a valid thumbnail will be filtered out. |
| PATCH | /v1/games/{universeId}/user-votes | |
| GET | /v1/games/{universeId}/votes | |
| GET | /v1/games/{universeId}/votes/user | |
| GET | /v1/gametemplates | Gets a page of templates that can be used to start off making games. |
| GET | /v1/gender | Get the user's gender |
| POST | /v1/gender | Update the user's gender |
| GET | /v1/gender#users.roblox.com | Get the user's gender |
| POST | /v1/gender#users.roblox.com | Update the user's gender |
| GET | /v1/groups/icons | Fetches thumbnail URLs for a list of groups. Ids that do not correspond to groups will be filtered out. |
| GET | /v1/groups/{groupId}/community-feature-freezes | Gets the freeze status of the community features for a group. |
| POST | /v1/groups/{groupId}/community-tier/evaluate | |
| GET | /v1/groups/{groupId}/features | Gets the freeze status of all features and the lock status for a group. |
| PATCH | /v1/groups/{groupId}/features | Sets the desired status of group features. Currently only removes active freezes for features set to Roblox.Groups.Api.FeatureStatus.On. |
| GET | /v1/groups/{groupId}/payouts/latest | Gets the latest one-time payout for each requested user. |
| GET | /v1/groups/{groupId}/payouts/suggested | Gets suggested one-time payouts for eligible collaborators. |
| GET | /v1/groups/{groupId}/payouts/universes | Gets payout-visible universes for a group. |
| GET | /v1/groups/{groupId}/universes | Gets a list of universes for the given group. |
| POST | /v1/identity-verification/login | Endpoint for login with identity verification |
| POST | /v1/identity/initialize-login | Initiates identifier-first login flow by returning a list of login methods for user(s). |
| GET | /v1/installer-cdns | Get information about which CDNs to use for installation. |
| GET | /v1/locales | Get list of Supported locales with user locus information. |
| POST | /v1/locales/set-show-roblox-translations | Sets whether translations suggested by Roblox will be shown to the user. |
| POST | /v1/locales/set-user-supported-locale | Sets user's supported locale. Null supported locale will clear out user's supported locale (set users' supported locale to null) |
| GET | /v1/locales/supported-locales | Get list of supported locales sorted by the Native Name property. |
| GET | /v1/locales/supported-locales-for-creators | |
| GET | /v1/locales/user-locale | Gets user locale. If user is absent returns, locale from http request object. |
| GET | /v1/locales/user-localization-locus-supported-locales | Gets each of a user's localization locus supported locales. A localization locus supported locale is a page (or group of pages) that have been defined by the International team which need independent locale support. If the user is null we will attempt to return the locales appropriate for the user's device language. |
| GET | /v1/localization-table/limits | Get limits for translation table entries operations |
| GET | /v1/localization-table/metadata | Get metadata for localization UI |
| POST | /v1/localization-table/tables | Creates a Localization Table with the given data. Note that this endpoint simply creates a table and does not associate it with any universe, so if intending to use this to create tables usable in experience more setup will be needed to grant those experiences access. |
| GET | /v1/localization-table/tables/{assetId} | Get table information by the assetId of the table. |
| GET | /v1/localization-table/tables/{tableId} | Get table information by the id of the table. |
| PATCH | /v1/localization-table/tables/{tableId} | Updates the tables contents based on what is provided. |
| GET | /v1/localization-table/tables/{tableId}/asset-entries | Gets a page of asset (image) entries for the specified table, along with the table's per-locale asset translations. |
| GET | /v1/localization-table/tables/{tableId}/entries | Gets a batch of entries for a table. |
| POST | /v1/localization-table/tables/{tableId}/entries/translation-feedback | Gets the translation feedback for each entry passed in. |
| POST | /v1/localization-table/tables/{tableId}/entries/translation-history | Gets the translation history for each entry passed in. |
| GET | /v1/localization-table/tables/{tableId}/entry-count | Gets the number of entries in the specified table |
| POST | /v1/login | Authenticates a user. |
| POST | /v1/login/linked | Endpoint for logging in a user, specifically for linked authentication on PCGDK |
| POST | /v1/logout | Destroys the current authentication session. |
| POST | /v1/logoutfromallsessionsandreauthenticate | Logs out user from all other sessions. |
| GET | /v1/marAssetHash/{marAssetHash}/marCheckSum/{marCheckSum} | Retrieves an asset by its mar (moderation agnostic) hash and mar (moderation agnostic) checksum. |
| GET | /v1/messages | Gets a user's messages. |
| POST | /v1/messages/archive | Archives a batch of messages. |
| POST | /v1/messages/mark-read | Marks a batch of messages as read. |
| POST | /v1/messages/mark-unread | Marks a batch of messages as unread. |
| POST | /v1/messages/unarchive | Unarchives a batch of messages. |
| GET | /v1/messages/unread/count | Gets unread messages for the authenticated user. |
| GET | /v1/messages/{messageId} | Gets a message's details. |
| GET | /v1/metadata | Get the metadata |
| GET | /v1/metadata#auth.roblox.com | Get the metadata |
| GET | /v1/metadata#twostepverification.roblox.com | Gets two step verification system metadata. |
| GET | /v1/mobile-client-version | Get mobile client version information based on app version parameter |
| GET | /v1/my/friends/count | Get the number of friends a user has |
| GET | /v1/my/friends/requests | Get all users that friend requests with targetUserId using exclusive start paging |
| GET | /v1/my/new-friend-requests/count | |
| GET | /v1/my/trusted-friends/requests | Get all incoming trusted friend requests using exclusive start paging. |
| POST | /v1/name-description/games/translation-history | Gets the history for name or description in a provided language. |
| GET | /v1/name-description/games/{gameId} | Gets a game's name and description in all supported languages |
| PATCH | /v1/name-description/games/{gameId} | Updates a game's name and/or description in multiple languages. |
| GET | /v1/name-description/metadata | Rollout settings for name/description migration to new page |
| POST | /v1/outfits/{userOutfitId}/delete | Deletes the outfit. |
| GET | /v1/outfits/{userOutfitId}/details | Gets details about the contents of an outfit. |
| GET | /v1/packages/{packageId}/assets | Given a package ID, returns the list of asset IDs for that package |
| POST | /v1/passkey/DeleteCredentialBatch | Disables a batch of credentials for the specified user. |
| POST | /v1/passkey/FinishRegistration | Complete Passkey registration by providing credential creation options. |
| POST | /v1/passkey/ListCredentials | List a user's registered passkeys. |
| POST | /v1/passkey/RenameCredential | Rename a credential for the specified user. |
| POST | /v1/passkey/StartAuthentication | Provides a challenge for the Passkey to authenticate. |
| POST | /v1/passkey/StartRegistration | Initiates Passkey registration by providing credential creation options. |
| POST | /v1/passkey/finish-ar-preauth-registration | Finishes account recovery pre-auth passkey registration by validating the recovery session, deactivating the user's password, and completing passkey registration. |
| POST | /v1/passkey/finish-preauth-registration | |
| POST | /v1/passkey/start-authentication-by-user | Initializes passkey authentication for the user(s) corresponding to the identifier provided. |
| POST | /v1/passkey/start-preauth-registration | Initiates Passkey preauthenticated registration by providing credential creation options. |
| GET | /v1/passkey/su-eligibility | Checks whether the authenticated user is eligible for silent passkey upgrade. Route and response are intentionally obfuscated ("su-eligibility" = "silent-upgrade-eligibility"). |
| GET | /v1/passwords/validate | Endpoint for checking if a password is valid. |
| POST | /v1/passwords/validate | Endpoint for checking if a password is valid. |
| GET | /v1/phone | Get Verified Phone Number |
| POST | /v1/phone | Set Phone Number |
| POST | /v1/phone/delete | Delete Phone |
| POST | /v1/phone/resend | Resend Phone code |
| POST | /v1/phone/verify | Verify Phone |
| GET | /v1/places/gameicons | Fetches game icon URLs for a list of places. Ids that do not correspond to a valid place will be filtered out. |
| PATCH | /v1/places/{placeId} | Updates the place configuration for the place with the id placeId |
| POST | /v1/places/{placeId} | Updates the place configuration for the place with the id placeId |
| GET | /v1/places/{placeId}/teamcreate/active_session/members | List of users in the active Team Create session |
| GET | /v1/plugins | Gets plugin details by ids. |
| PATCH | /v1/plugins/{pluginId} | Updates a plugin. |
| DELETE | /v1/preferences/publishing | |
| GET | /v1/preferences/publishing | |
| PATCH | /v1/preferences/publishing | |
| POST | /v1/preferences/publishing | |
| POST | /v1/presence/users | |
| GET | /v1/promotion-channels | Get the user's promotion channels |
| POST | /v1/promotion-channels | Update the user's promotion channels |
| GET | /v1/recovery/metadata | Get metadata for forgot endpoints |
| GET | /v1/resize/{hash}/{width}/{height}/{type}/{format}/{filterType} | Resizes larger thumbnails to specified size and format |
| GET | /v1/revert/account | Get Revert Account ticket info |
| POST | /v1/revert/account | Submit Revert Account Request |
| POST | /v1/revert/invalidate-tickets | Invalidates all account security tickets for the authenticated user. This endpoint should be called before enrolling in EPP to ensure old revert links cannot be used. |
| GET | /v1/secureresize/{thumbPrint}/{hash}/{width}/{height}/{type}/{format}/{filterType} | Decrypts and Resizes larger thumbnails to specified size and format |
| POST | /v1/session/refresh | Logs out user from the current session and create a new one. |
| POST | /v1/signup | Endpoint for signing up a new user |
| POST | /v1/signup/linked | Endpoint for signing up a new user through linked authentication. |
| GET | /v1/social/connected-providers | Get social network user information if the given social auth method is connected to current user. |
| POST | /v1/social/{provider}/disconnect | Removes the given social authentication method from current Roblox user if it is connected. |
| GET | /v1/source-language/games/{gameId} | Gets the source language of a game |
| PATCH | /v1/source-language/games/{gameId} | Sets the source language of a game |
| GET | /v1/source-language/games/{gameId}/language-with-locales | Gets the source language of a game |
| GET | /v1/supported-languages/games/{gameId} | Get the supported languages for a game. |
| PATCH | /v1/supported-languages/games/{gameId} | Add or remove supported languages for a game. |
| GET | /v1/supported-languages/games/{gameId}/automatic-translation-status | Get the automatic translation status of supported languages for a game. |
| GET | /v1/supported-languages/games/{gameId}/in-experience-language-selection | Get the user's in-experience language selector languages for a game. |
| PATCH | /v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status | Enable or disable automatic translation for a game and language. |
| PATCH | /v1/supported-languages/games/{gameId}/languages/{languageCode}/image-translation-status | Enable or disable image translation for a game and language. |
| PATCH | /v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings | Update the switch which controls if the UniverseDisplayInformation should be automatically translated. |
| GET | /v1/supported-languages/games/{gameId}/universe-display-info-automatic-translation-settings | Get UniverseDisplayInfo automatic translation settings. |
| GET | /v1/supported-languages/metadata | Rollout settings for supported languages of a game |
| POST | /v1/trades/expire-outdated | Deprecated. TradeSession are automatically set to expire while the inbound/outbound trades are fetched. Expires Outdated Inbound Trades for User |
| GET | /v1/trades/metadata | Gets metadata about the trade system. |
| POST | /v1/trades/send | Sends a trade. |
| GET | /v1/trades/{tradeId} | Gets detailed information about a trade. |
| POST | /v1/trades/{tradeId}/accept | Accepts a trade. |
| POST | /v1/trades/{tradeId}/counter | Counters a trade. |
| POST | /v1/trades/{tradeId}/decline | Declines a trade. |
| GET | /v1/trades/{tradeStatusType} | Fetches a list of the authenticated user's trades. |
| GET | /v1/trades/{tradeStatusType}/count | Gets the total number of pending trades for the authenticated user. Inbound is the only accepted tradeStatusType. |
| GET | /v1/translation-analytics/games/{gameId}/download-translation-analytics-report | Download translation analytics report after the report is ready |
| POST | /v1/translation-analytics/games/{gameId}/request-translation-analytics-report | Request translation analytics report to be generated |
| GET | /v1/translation-analytics/metadata | Get metadata related to UI and rollout settings |
| GET | /v1/ui-configurations | Get ui configurations for frontend to use. |
| GET | /v1/universes/multiget | Gets a list of universes. |
| GET | /v1/universes/multiget/permissions | Returns an array of granted and declined permissions related to the universes with the ids in ids for the authenticated user. |
| GET | /v1/universes/multiget/teamcreate | Gets TeamCreate settings for multiple universes specified by Ids |
| GET | /v1/universes/user-public-publish-eligibility | Returns the result of various checks for a user's eligibility to publish a public universe |
| GET | /v1/universes/{universeId} | Gets a Roblox.Api.Develop.Models.UniverseModel. |
| POST | /v1/universes/{universeId}/activate | Activates a universes. |
| GET | /v1/universes/{universeId}/activation-eligibility | Returns the result of various checks for a user's eligibility to activate a given universe from private to public universeId for authenticated user |
| GET | /v1/universes/{universeId}/badges | Gets badges by their awarding game. |
| POST | /v1/universes/{universeId}/badges | Creates a new badge. |
| GET | /v1/universes/{universeId}/configuration | Get settings for an owned universe. |
| PATCH | /v1/universes/{universeId}/configuration | Update universe settings for an owned universe. |
| DELETE | /v1/universes/{universeId}/configuration/playtesters | Remove playtesters from an owned universe. |
| GET | /v1/universes/{universeId}/configuration/playtesters | Get the list of playtesters for an owned universe. |
| POST | /v1/universes/{universeId}/configuration/playtesters | Add playtesters to an owned universe. Existing ids are ignored (additive union). |
| POST | /v1/universes/{universeId}/configuration/playtesters/eligibility | Check whether each candidate user can currently be added as a private playtester. |
| GET | /v1/universes/{universeId}/configuration/vip-servers | Get settings for an owned universe's VIP servers. |
| POST | /v1/universes/{universeId}/deactivate | Deactivates a universe. |
| GET | /v1/universes/{universeId}/free-badges-quota | Gets the number of free badges left for the current UTC day by their awarding game. |
| GET | /v1/universes/{universeId}/payouts | Gets recurring payouts for a group-owned universe. |
| GET | /v1/universes/{universeId}/permissions | Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user |
| GET | /v1/universes/{universeId}/places | Gets a list of places for a universe. |
| GET | /v1/universes/{universeId}/stats | Get statistics data for a universe. |
| GET | /v1/universes/{universeId}/teamcreate | Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse. |
| PATCH | /v1/universes/{universeId}/teamcreate | Edit team create settings for a universe. |
| DELETE | /v1/universes/{universeId}/teamcreate/memberships | Removes a user from a TeamCreate permissions list. |
| GET | /v1/user-localization-settings/player-choice/{universeId} | Get user player choice settings for universe. |
| GET | /v1/user-localization-settings/universe/{universeId} | Get user localization settings for universe. |
| POST | /v1/user-localization-settings/universe/{universeId} | Set user localization settings for universe. |
| DELETE | /v1/user/badges/{badgeId} | Removes a badge from the authenticated user. |
| GET | /v1/user/currency | Gets currency for the authenticated user. |
| GET | /v1/user/friend-requests/count | Return the number of pending friend requests. |
| POST | /v1/user/get-tags | Gets the tags for multiple users |
| GET | /v1/user/groups/canmanage | Gets a list of Groups that a user can manage. |
| GET | /v1/user/groups/canmanagegamesoritems | Gets a list of groups a user can manage games or items for. |
| POST | /v1/user/passwords/change | Changes the password for the authenticated user. |
| POST | /v1/user/tag | Sets the tag for a user |
| GET | /v1/user/tag/validate | Validates the tag for a user |
| GET | /v1/user/trusted-friend-requests/count | Return the number of pending trusted friend requests. |
| GET | /v1/user/universes | Gets a list of universes for the authenticated user. |
| POST | /v1/username | Change the user's username |
| GET | /v1/username/change/price | Get the current price for a username change |
| GET | /v1/usernames | Gets a list of existing usernames on Roblox based on the query parameters |
| POST | /v1/usernames/recover | Sends an email of all accounts belonging to an email |
| POST | /v1/usernames/users | Get users by usernames. |
| GET | /v1/usernames/validate | Checks if a username is valid. |
| POST | /v1/usernames/validate | Checks if a username is valid. |
| POST | /v1/users | Get users by ids. |
| GET | /v1/users/authenticated | Gets the minimal authenticated user. |
| GET | /v1/users/authenticated/age-bracket | Gets the age bracket of the authenticated user. |
| GET | /v1/users/authenticated/country-code | Gets the country code of the authenticated user. |
| GET | /v1/users/authenticated/roles | Gets the (public) roles of the authenticated user, such as "Soothsayer" and "BetaTester". |
| GET | /v1/users/avatar | Get Avatar Full body shots for the given CSV of userIds |
| GET | /v1/users/avatar-3d | Get Avatar 3d object for a user |
| GET | /v1/users/avatar-bust | Get Avatar Busts for the given CSV of userIds |
| GET | /v1/users/avatar-headshot | Get Avatar Headshots for the given CSV of userIds |
| GET | /v1/users/outfit-3d | Get 3d object for an outfit |
| GET | /v1/users/outfits | Get outfits for the given CSV of userOutfitIds |
| GET | /v1/users/search | Searches for users by keyword. |
| GET | /v1/users/{userId} | Gets detailed user information by id. |
| GET | /v1/users/{userId}/assets/collectibles | Gets all collectible assets owned by the specified user. |
| GET | /v1/users/{userId}/avatar | Returns details about a specified user's avatar. |
| GET | /v1/users/{userId}/bundles/{bundleType} | |
| GET | /v1/users/{userId}/can-trade-with | Returns whether you can trade with another user. |
| GET | /v1/users/{userId}/can-view-inventory | Gets whether the specified user's inventory can be viewed. |
| GET | /v1/users/{userId}/categories | Return inventory categories for a user |
| GET | /v1/users/{userId}/categories/favorites | Return favorites categories for a user |
| POST | /v1/users/{userId}/challenges/authenticator/verify | Verifies a two step verification challenge code via authenticator app. |
| POST | /v1/users/{userId}/challenges/cross-device/retract | Reverts a user's dialog state from ACTIVE to PENDING. |
| POST | /v1/users/{userId}/challenges/cross-device/retry | Retry a Cross Device two step verification approval. |
| POST | /v1/users/{userId}/challenges/cross-device/verify | Verifies a two step verification approval via Cross Device. Cross Device approval does not use a verification code. |
| POST | /v1/users/{userId}/challenges/email/send-code | Sends a two step verification challenge code via email. |
| POST | /v1/users/{userId}/challenges/email/verify | Verifies a two step verification challenge with a code sent via email. |
| POST | /v1/users/{userId}/challenges/passkey/verify-finish | Validates the assertion data returned by the passkey. |
| POST | /v1/users/{userId}/challenges/passkey/verify-start | Provides a challenge for the passkey to authenticate. |
| POST | /v1/users/{userId}/challenges/password/verify | Verifies a two step verification challenge with a password (code). |
| POST | /v1/users/{userId}/challenges/recovery-codes/verify | Verifies a two step verification challenge via a recovery code. |
| POST | /v1/users/{userId}/challenges/security-key/verify-finish | Validates the assertion data returned by the security key. |
| POST | /v1/users/{userId}/challenges/security-key/verify-start | Provides a challenge for the security key to authenticate. |
| POST | /v1/users/{userId}/challenges/sms/send-code | Sends a two step verification code via SMS for the specified user. |
| POST | /v1/users/{userId}/challenges/sms/verify | Verifies a two step verification challenge with a code sent via SMS. |
| GET | /v1/users/{userId}/configuration | Gets two step verification configuration for the specified user. |
| POST | /v1/users/{userId}/configuration/authenticator/disable | Disables two step verification via authenticator for the specified user. |
| POST | /v1/users/{userId}/configuration/authenticator/enable | Initiates enabling authenticator-based two step verification for the specified user. |
| POST | /v1/users/{userId}/configuration/authenticator/enable-verify | Finishes enabling authenticator-based two step verification for the specified user. |
| POST | /v1/users/{userId}/configuration/email/disable | Disables two step verification via email for the specified user. |
| POST | /v1/users/{userId}/configuration/email/enable | Enables two step verification via email for the specified user. |
| POST | /v1/users/{userId}/configuration/security-key/disable | Disables a batch of credentials for the specified user. |
| POST | /v1/users/{userId}/configuration/security-key/enable | Initiates security key registration by providing credential creation options. |
| POST | /v1/users/{userId}/configuration/security-key/enable-verify | Finishes security key registration and stores credential. Enables security key as a 2sv media type if it is a user's first key. |
| POST | /v1/users/{userId}/configuration/security-key/list | List a user's registered security keys. |
| POST | /v1/users/{userId}/configuration/sms/disable | Disables two step verification via SMS for the specified user. |
| POST | /v1/users/{userId}/configuration/sms/enable | Enables two step verification via SMS for the specified user. |
| GET | /v1/users/{userId}/currently-wearing | Gets a list of asset ids that the user is currently wearing. |
| PATCH | /v1/users/{userId}/display-names | Set the display name for the authorized user. |
| GET | /v1/users/{userId}/display-names/validate | Validate a display name for an existing user. |
| GET | /v1/users/{userId}/friends/statuses | Gets a list of friend statuses of specified users against the specified user. |
| GET | /v1/users/{userId}/items/{itemType}/{itemTargetId} | Gets owned items of the specified item type. Game Servers can make requests for any user, but can only make requests for game passes that belong to the place sending the request. Place creators can make requests as if they were the Game Server. |
| GET | /v1/users/{userId}/items/{itemType}/{itemTargetId}/is-owned | Gets whether a user owns an item of type itemType with id itemTargetId. |
| GET | /v1/users/{userId}/outfits | Deprecated, user v2. Gets a list of outfits for the specified user. |
| GET | /v1/users/{userId}/places/inventory | Gets Created, MyGames, or OtherGames places inventory for a user |
| GET | /v1/users/{userId}/promotion-channels | Get promotion channels for a given user ID |
| GET | /v1/users/{userId}/recovery-codes | Gets the current status of recovery codes for a user. |
| POST | /v1/users/{userId}/recovery-codes/clear | Clears any existing recovery codes for the user. |
| POST | /v1/users/{userId}/recovery-codes/regenerate | Clears any existing recovery codes and generates a new batch of recovery codes. |
| GET | /v1/users/{userId}/roblox-badges | Returns a list of Roblox badges belonging to a user. |
| GET | /v1/users/{userId}/universes | Gets all the followings between a user with userId and universes |
| DELETE | /v1/users/{userId}/universes/{universeId} | Deletes the following between a user with userId and universe with universeId |
| POST | /v1/users/{userId}/universes/{universeId} | Creates the following between a user with userId and universe with universeId |
| GET | /v1/users/{userId}/universes/{universeId}/status | Gets the status of a following relationship between a user and a universe. |
| GET | /v1/users/{userId}/username-history | Retrieves the username history for a particular user. |
| GET | /v1/validators/email | Tries to check if an email is valid |
| GET | /v1/validators/recommendedUsernameFromDisplayName | Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available. |
| POST | /v1/validators/recommendedUsernameFromDisplayName | Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available. This is a POST request and explicitly does not receive the parameter values from the query |
| GET | /v1/validators/username | Tries to get a valid username if the current username is taken |
| POST | /v1/validators/username | Tries to get a valid username if the current username is taken This is a POST request and explicitly does not receive the parameter values from the query |
| GET | /v1/xbox/connection | Check if the current user has an Xbox connected. Also returns the gamertag of the Xbox account if connected. |
| POST | /v1/xbox/disconnect | Unlink the current ROBLOX account from the Xbox live account. |
| GET | /v1/xbox/get-login-consecutive-days | Get the consecutive days the xbox user has been logged in. |
| POST | /v1/xbox/translate | Translate the xbox user to roblox user. |
| GET | /v2/android-binaries/{version}/channels/{channelName} | Retrieve the Android binary information for a given version and channel name. |
| GET | /v2/asset | |
| GET | /v2/assetId/{assetId} | |
| GET | /v2/assetId/{assetId}/version/{versionNumber} | |
| POST | /v2/assets/batch | |
| GET | /v2/assets/{assetId}/owners | Gets a list of owners of an asset. |
| GET | /v2/auth/metadata | Gets Auth meta data |
| PATCH | /v2/avatar | Sets the avatar to the incoming avatar using field masks. |
| GET | /v2/avatar/avatar | Returns details about the authenticated user's avatar. |
| POST | /v2/avatar/set-body-colors | Sets the authenticated user's body colors. |
| POST | /v2/avatar/set-wearing-assets | Sets the avatar's current assets to the list. |
| GET | /v2/avatar/users/{userId}/avatar | Returns details about a specified user's avatar. |
| GET | /v2/avatar/users/{userId}/outfits | Gets a list of outfits for the specified user. |
| GET | /v2/client-version/{binaryType} | Get client version information for specific binary type |
| GET | /v2/client-version/{binaryType}/channel/{channelName} | Get client version information for specific binary type |
| GET | /v2/collectible-items/{collectibleItemId}/owners | Gets a list of owners of a collectible item. |
| GET | /v2/compression-dictionaries | Returns a listing of all known compression dictionaries, including their SHA256 and creation date. This will be sorted by creation date, with the most recent dictionaries first. |
| GET | /v2/compression-dictionaries/{dictionarySha256} | Returns the specified compression dictionary as a file download. |
| GET | /v2/games/{universeId}/media | Get the game media data |
| GET | /v2/groups/{groupId}/invitations | List open invitations to a group |
| POST | /v2/groups/{groupId}/invitations | Invite a user to a group |
| DELETE | /v2/groups/{groupId}/invitations/{invitationId} | Revoke an invitation to a group (member manager) |
| GET | /v2/groups/{groupId}/invitations/{invitationId} | Get an invitation to a group |
| PATCH | /v2/groups/{groupId}/invitations/{invitationId} | Accept or decline an invitation to a group (recipient) |
| GET | /v2/groups/{groupId}/roles/{roleId}/invitations | List open invitations to a group that grant a role |
| GET | /v2/groups/{groupId}/users/{userId}/invitation | Get the open invitation to a group for a user |
| POST | /v2/identity-verification/login | Endpoint for login with identity verification |
| DELETE | /v2/inventory/asset/{assetId} | Give up an asset owned by the authenticated user. Assets that are created by Roblox user or are limited edition are not eligible for deletion and will return NotEligibleForDelete. |
| POST | /v2/login | Authenticates a user. |
| POST | /v2/login/linked | Endpoint for logging in a user, specifically for linked authentication on PCGDK |
| POST | /v2/logout | Destroys the current authentication session. |
| POST | /v2/logoutfromallsessionsandreauthenticate | Logs out user from all other sessions. |
| GET | /v2/marAssetHash/{marAssetHash}/marCheckSum/{marCheckSum} | |
| GET | /v2/metadata | Get the metadata |
| GET | /v2/ota-version/{binaryType} | Get OTA information for a specific binary type with a given version on some channel. Returns empty list if no updates are found or channel/application with the given version does not exist in CVS. |
| POST | /v2/outfits/create | Creates a new outfit. |
| PATCH | /v2/outfits/{userOutfitId} | Updates the contents of an outfit. |
| GET | /v2/passwords/current-status | Returns password status for current user, asynchronously. |
| GET | /v2/passwords/reset | Gets metadata needed for the password reset view. |
| POST | /v2/passwords/reset | Resets a password for a user that belongs to the password reset ticket. |
| POST | /v2/passwords/reset/send | Sends a password reset email or challenge to the specified target. |
| POST | /v2/passwords/reset/verify | Verifies a password reset challenge solution. |
| GET | /v2/passwords/validate | Endpoint for checking if a password is valid. |
| POST | /v2/passwords/validate | Endpoint for checking if a password is valid. |
| GET | /v2/places/{placeId} | Gets the place configuration for the place with the id placeId |
| PATCH | /v2/places/{placeId} | Updates the place configuration for the place with the id placeId |
| GET | /v2/push-notifications/chrome-manifest | Get Chrome Manifest to link GCM project to Chrome Browser |
| POST | /v2/push-notifications/deregister-all-devices | De-register all devices to disable push notifications |
| POST | /v2/push-notifications/deregister-current-device | De-register current device to disable push notifications |
| POST | /v2/push-notifications/deregister-current-device-ios-pushkit | De-register current device to disable pushkit notifications |
| GET | /v2/push-notifications/get-current-device-destination | Gets the current device destination |
| GET | /v2/push-notifications/get-destinations | Gets valid destinations associated with the signed user |
| GET | /v2/push-notifications/metadata | Gets the corresponding metadata for the specified notification |
| POST | /v2/push-notifications/register-android-native | Register Android Native for push notifications |
| POST | /v2/push-notifications/register-ios-native | Registers IOS device for push notifications |
| POST | /v2/push-notifications/register-ios-pushkit | Registers IOS device for pushkit notifications |
| GET | /v2/recovery/metadata | Get metadata for forgot endpoints |
| GET | /v2/revert/account | Get Revert Account ticket info |
| POST | /v2/revert/account | Submit Revert Account Request |
| POST | /v2/revert/invalidate-tickets | Invalidates all account security tickets for the authenticated user. This endpoint should be called before enrolling in EPP to ensure old revert links cannot be used. |
| GET | /v2/search/items/details | Search for catalog items. |
| POST | /v2/session/refresh | Logs out user from the current session and create a new one. |
| POST | /v2/signup | Endpoint for signing up a new user |
| POST | /v2/signup/linked | Endpoint for signing up a new user through linked authentication. |
| GET | /v2/sponsored-campaigns | Gets a page of Roblox.AdConfiguration.Api.SponsoredCampaignModel with specified input parameters. |
| POST | /v2/sponsored-campaigns/create | Creates a complete ad. Including ad campaign, ad set, escrow, and the ad. Currently intended for creation of sponsorships only. |
| GET | /v2/sponsored-campaigns/eligible-asset-type-ids | Get all asset type IDs that are eligible to be sponsored. |
| POST | /v2/sponsored-campaigns/eligible-campaign-targets | Returns a collection of Roblox.AdConfiguration.Api.Models.CampaignTargetModel that the user is authorized to sponsor, ordered by most recently advertised |
| GET | /v2/sponsored-campaigns/multi-get-can-user-sponsor | Checks whether the targets are eligible for sponsorship, and if the user is authorized to sponsor the targets. |
| POST | /v2/sponsored-campaigns/stop | Stops a sponsored campaign / ad (ad set) from running. Initiated by a user. |
| GET | /v2/sponsored-games | Gets a page of Roblox.AdConfiguration.Api.SponsoredGameV2Model with specified input parameters. |
| POST | /v2/sponsored-games/create | Creates a new sponsored game ad with specified input parameters. |
| POST | /v2/sponsored-games/stop | To stop a sponsored-game ad (ad set) from running, initiated by a user. |
| GET | /v2/sponsored-games/universes | Gets a list of universes for the authenticated user, or the given group, ordered by most recently created sponsored game ads. |
| POST | /v2/stream-notifications/clear-unread | Clears the unread Notification stream count |
| GET | /v2/stream-notifications/get-latest-game-updates | Get the latest non aggregated Game Updates sent to the logged in user |
| GET | /v2/stream-notifications/get-recent | Gets the recent entries from the notification stream |
| GET | /v2/stream-notifications/metadata | Get Notification Stream metadata. |
| GET | /v2/stream-notifications/unread-count | Gets the count of unread Notification stream entries |
| GET | /v2/supported-languages/games/{gameId} | Get the supported languages for a game. |
| DELETE | /v2/teamtest/{placeId} | Close a game instance that is being used for team testing |
| POST | /v2/trades/send | Sends a new trade. |
| GET | /v2/trades/{tradeId} | Gets the details of a trade. |
| POST | /v2/trades/{tradeId}/counter | Counters an existing trade. |
| PATCH | /v2/universes/{universeId}/configuration | Update universe settings for an owned universe. V2 Contains data for avatar scale and asset override. |
| GET | /v2/user-channel | Get channel name for currently logged in user |
| POST | /v2/user/passwords/change | Changes the password for the authenticated user. |
| POST | /v2/username | Change the user's username |
| GET | /v2/username/change/price | Get the current price for a username change |
| GET | /v2/usernames | Gets a list of existing usernames on Roblox based on the query parameters |
| POST | /v2/usernames/recover | Sends an email of all accounts belonging to an email |
| GET | /v2/usernames/validate | Checks if a username is valid. |
| POST | /v2/usernames/validate | Checks if a username is valid. |
| GET | /v2/users/me/can-trade | Checks if the calling user can trade with others. |
| GET | /v2/users/{userId}/can-trade-with | Checks if the user can trade with a specific user. |
| GET | /v2/users/{userId}/favorite/games | Gets users favorite games. |
| GET | /v2/users/{userId}/games | Gets games created by the specified user. |
| GET | /v2/users/{userId}/inventory | Get user's inventory by multiple Roblox.Platform.Assets.AssetType. |
| GET | /v2/users/{userId}/inventory/{assetTypeId} | Gets user's inventory based on specific asset type |
| GET | /v2/users/{userId}/tradableItems | Gets tradable items for a user. |
| GET | /v2/users/{userId}/universes | Gets all universes followed by a user. |
| POST | /v3/logout | Destroys the current authentication session while reporting metrics like url and reason for logout. |
| POST | /v3/outfits/create | Creates a new outfit. |
| PATCH | /v3/outfits/{userOutfitId} | Updates the contents of an outfit. |
| GET | /v3/outfits/{userOutfitId}/details | Gets details about the contents of an outfit. |
| POST | /v3/users/{userId}/two-step-verification/login | Authenticates as a user given a two step verification verification token. |
| GET | /v4/avatar | Gets the currently wearing avatar definition for the authenticated user. |
| PATCH | /v4/avatar | Sets the avatar to the incoming avatar using field masks. |
| GET | /v4/avatar/users/{userId} | Gets the currently wearing avatar definition for the specified user. |
| POST | /v4/outfits/create | Creates a new outfit. |
| PATCH | /v4/outfits/{outfitId} | Updates the contents of an outfit. |
| GET | /v4/outfits/{outfitId}/details | Gets the definition for an outfit. |
| DELETE | /virtual-events/v3/game-events/{eventId} | Permanently delete an existing game event. Returns 204 No Content on success. Permission is enforced via an explicit pre-check: callers that can read but not edit receive 403; callers that cannot read receive 404. |
| GET | /virtual-events/v3/game-events/{eventId} | Get a single game event by ID. Use ?fields= to request a subset of fields; unknown field names return 400. |
| PATCH | /virtual-events/v3/game-events/{eventId} | Partially update a game event. Only fields present in the request body are changed; omitted or null fields are left unchanged. Empty body is a no-op and returns the current game event resource. |
| GET | /virtual-events/v3/universes/{universeId}/game-events | List game events under a universe. Use ?fields= to trim the response payload. Response is always 200 (empty list for unknown universe). |
| POST | /virtual-events/v3/universes/{universeId}/game-events | Create a new game event. Returns the full resource on success. |
Schemas
Roblox.AccountInformation.Api.Models.PromotionChannelsByUserIdResponse
Roblox.AccountInformation.Api.Models.PromotionChannelsRequest
Roblox.AccountInformation.Api.Models.PromotionChannelsResponse
Roblox.AdConfiguration.Api.Models.CreateSponsoredCampaignRequest
Roblox.AdConfiguration.Api.Models.GetCampaignTargetsResponse
Roblox.AdConfiguration.Api.Models.GetEligibleCampaignTargetsRequest
Roblox.AdConfiguration.Api.Models.GetRecentAdsRankedUniversesResponse
Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest
Roblox.AdConfiguration.Api.Models.StopSponsoredGameV2Request
Roblox.Api.Avatar.Models.AvatarFilteredPageResponse_Roblox.Api.Avatar.Models.OutfitModel_
Roblox.Api.Avatar.Models.AvatarPageResponse_Roblox.Api.Avatar.Models.OutfitModel_
Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationCameraModel
Roblox.Api.Avatar.Models.UniverseAvatarAssetOverrideResponseModel
Roblox.Api.Avatar.Models.V4.Request.CreateOutfitDefinitionRequestV4
Roblox.Api.Avatar.Models.V4.Request.UpdateAvatarDefinitionRequestV4
Roblox.Api.Avatar.Models.V4.Request.UpdateOutfitDefinitionRequestV4
Roblox.Api.Avatar.Models.V4.Response.AvatarValidationResultV4
Roblox.Api.Avatar.Models.V4.Response.CreateOutfitDefinitionResponseV4
Roblox.Api.Avatar.Models.V4.Response.InvalidThumbnailCustomizationResponse
Roblox.Api.Avatar.Models.V4.Response.OutfitValidationResultV4
Roblox.Api.Avatar.Models.V4.Response.UpdateAvatarDefinitionResponseV4
Roblox.Api.Avatar.Models.V4.Response.UpdateOutfitDefinitionResponseV4
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.AgeRangeModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.AgeRecommendationDetailsModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.AgeRecommendationModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.AgeRecommendationSummaryModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.ExperienceDescriptorModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.ExperienceDescriptorUsageModel
Roblox.Api.Develop.Models.BuildGeneratedRatingPreviewResponse.RestrictedCountryModel
Roblox.Api.Develop.Models.Response.TeamCreateSettingsResponse
Roblox.Api.Develop.Models.UserPublicPublishEligibilityResponse
Roblox.Api.Notifications.Models.GetCurrentPushDestinationResponseModel
Roblox.Api.Notifications.Models.GetPushDestinationsResponseModel
Roblox.Api.Notifications.Models.NotificationStreamEntriesModel
Roblox.Api.Notifications.Models.PushNotificationClientMetadata
Roblox.Api.Notifications.Models.PushNotificationRegistration
Roblox.Api.Notifications.Models.RegisterIOSNativeRequestModel
Roblox.Api.Notifications.Models.RegisterIOSPushKitRequestModel
Roblox.Api.Notifications.Models.ResponseModels.NotificationStreamMetadataResponse
Roblox.Api.Notifications.Models.UnreadStreamNotificationsModel
Roblox.Authentication.Api.Models.AuthMethodsMetadataResponse
Roblox.Authentication.Api.Models.PasswordResetMetadataResponse
Roblox.Authentication.Api.Models.PasswordResetVerificationRequest
Roblox.Authentication.Api.Models.PasswordResetVerificationResponse
Roblox.Authentication.Api.Models.RecommendedUsernameFromDisplayNameRequest
Roblox.Authentication.Api.Models.RecommendedUsernameResponse
Roblox.Authentication.Api.Models.Request.DeletePasskeysRequest
Roblox.Authentication.Api.Models.Request.ExternalAccessRequest
Roblox.Authentication.Api.Models.Request.ExternalLoginAndLinkRequest
Roblox.Authentication.Api.Models.Request.ExternalLoginRequest
Roblox.Authentication.Api.Models.Request.ExternalSignupRequest
Roblox.Authentication.Api.Models.Request.ExternalUnlinkRequest
Roblox.Authentication.Api.Models.Request.FinishARPreAuthPasskeyRegistrationRequest
Roblox.Authentication.Api.Models.Request.FinishPasskeyPreauthRegistrationRequest
Roblox.Authentication.Api.Models.Request.FinishPasskeyRegistrationRequest
Roblox.Authentication.Api.Models.Request.IdentityVerificationLoginRequest
Roblox.Authentication.Api.Models.Request.InitializeLoginRequest
Roblox.Authentication.Api.Models.Request.ListPasskeysRequest
Roblox.Authentication.Api.Models.Request.LogoutFromAllSessionsAndReauthenticateRequest
Roblox.Authentication.Api.Models.Request.RenamePasskeyRequest
Roblox.Authentication.Api.Models.Request.SecureAuthenticationIntentModel
Roblox.Authentication.Api.Models.Request.StartAuthenticationByUserRequest
Roblox.Authentication.Api.Models.Request.StartPasskeyPreauthRegistrationRequest
Roblox.Authentication.Api.Models.Request.StartPasskeyRegistrationRequest
Roblox.Authentication.Api.Models.Response.ExternalIdentityGateway.ExternalIdentityAccessResponse
Roblox.Authentication.Api.Models.Response.ExternalIdentityGateway.ExternalIdentityNonceResponse
Roblox.Authentication.Api.Models.Response.ExternalIdentityGateway.ExternalLoginResponse
Roblox.Authentication.Api.Models.Response.GetClientAssertionResponse
Roblox.Authentication.Api.Models.Response.InitializeLoginResponse
Roblox.Authentication.Api.Models.Response.ListPasskeyCredentialResponse
Roblox.Authentication.Api.Models.Response.SilentUpgradeEligibilityResponse
Roblox.Authentication.Api.Models.Response.StartAuthenticationByUserResponse
Roblox.Authentication.Api.Models.Response.StartAuthenticationResponse
Roblox.Authentication.Api.Models.Response.StartPasskeyPreauthRegistrationResponse
Roblox.Authentication.Api.Models.Response.StartPasskeyRegistrationResponse
Roblox.Authentication.Api.Models.SocialAuthenticationDisconnectRequest
Roblox.Authentication.Api.Models.TwoStepVerificationSentResponse
Roblox.Authentication.Api.Models.TwoStepVerificationV3LoginResponse
Roblox.Authentication.Api.Models.UsernameChangePriceResponse
Roblox.Authentication.Api.Models.XboxCollectionsOfUserResponse
Roblox.Authentication.Api.Models.XboxLoginConsecutiveDaysResponse
Roblox.Catalog.Api.CatalogSearchPageResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_
Roblox.ClientSettings.Api.Models.Response.AndroidBinaryLibraryNames
Roblox.ClientSettings.Api.Models.Response.AndroidBinaryResponse
Roblox.ClientSettings.Api.Models.Response.ClientVersionResponse
Roblox.ClientSettings.Api.Models.Response.MobileClientVersionResponse
Roblox.ClientSettings.Api.Models.Response.MobileClientVersionResponseData
Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse
Roblox.ClientSettings.Api.Models.Response.UserChannelResponse
Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse
Roblox.Friends.Api.Models.Response.NewFriendRequestsCountResponse
Roblox.Friends.Api.Models.Response.TrustedFriendRequestResponse
Roblox.GameInternationalization.Api.AutomaticTranslationStatusTargetLanguage
Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse
Roblox.GameInternationalization.Api.EditImageTranslationStatusForGameAndLanguageResponse
Roblox.GameInternationalization.Api.GetAllowedAutomaticTranslationStatusForLanguagesResponse
Roblox.GameInternationalization.Api.GetAutomaticTranslationFeatureStatusForGameResponse
Roblox.GameInternationalization.Api.GetAutomaticTranslationQuotaForGameResponse
Roblox.GameInternationalization.Api.GetDeveloperProductIconResponse
Roblox.GameInternationalization.Api.GetGameThumbnailsResponse
Roblox.GameInternationalization.Api.GetNameDescriptionHistoryResponse
Roblox.GameInternationalization.Api.GetNameDescriptionHistoryV2Request
Roblox.GameInternationalization.Api.GetTranslationCountsForGameResponse
Roblox.GameInternationalization.Api.GetTranslationCountsForLanguageOrLocaleResponse
Roblox.GameInternationalization.Api.GetUiConfigurationsResponse
Roblox.GameInternationalization.Api.LanguageOrLocaleSettings
Roblox.GameInternationalization.Api.Models.Request.SetUserLocalizationSettingsRequest
Roblox.GameInternationalization.Api.Models.Response.GameNameDescriptionMetadataResponse
Roblox.GameInternationalization.Api.Models.Response.GetPlayerChoiceUniverseSettingsResponse
Roblox.GameInternationalization.Api.Models.Response.GetUserLocalizationSettingsForUniverseResponse
Roblox.GameInternationalization.Api.Models.Response.SetUserLocalizationSettingsResponse
Roblox.GameInternationalization.Api.Models.Response.UploadImageForGameThumbnailResponse
Roblox.GameInternationalization.Api.RequestTranslationAnalyticsReportRequest
Roblox.GameInternationalization.Api.RequestTranslationAnalyticsReportResponse
Roblox.GameInternationalization.Api.SourceLanguageWithLocales
Roblox.GameInternationalization.Api.SupportedLanguagesMetadataResponse
Roblox.GameInternationalization.Api.TranslationAnalyticsMetadataResponse
Roblox.GameInternationalization.Api.TranslationCountCategoryInfoResponse
Roblox.GameInternationalization.Api.TranslationCountGameInfoResponse
Roblox.GameInternationalization.Api.TranslationCountLanguageOrLocaleResponse
Roblox.GameInternationalization.Api.UniverseDisplayInfoAutomaticTranslationSettings
Roblox.GameInternationalization.Api.UpdateBadgeDescriptionRequest
Roblox.GameInternationalization.Api.UpdateBadgeDescriptionResponse
Roblox.GameInternationalization.Api.UpdateBadgeNameDescriptionRequest
Roblox.GameInternationalization.Api.UpdateBadgeNameDescriptionResponse
Roblox.GameInternationalization.Api.UpdateDeveloperProductDescriptionRequest
Roblox.GameInternationalization.Api.UpdateDeveloperProductDescriptionResponse
Roblox.GameInternationalization.Api.UpdateDeveloperProductNameDescriptionRequest
Roblox.GameInternationalization.Api.UpdateDeveloperProductNameDescriptionResponse
Roblox.GameInternationalization.Api.UpdateDeveloperProductNameRequest
Roblox.GameInternationalization.Api.UpdateDeveloperProductNameResponse
Roblox.GameInternationalization.Api.UpdateGamePassDescriptionRequest
Roblox.GameInternationalization.Api.UpdateGamePassDescriptionResponse
Roblox.GameInternationalization.Api.UpdateGamePassNameDescriptionRequest
Roblox.GameInternationalization.Api.UpdateGamePassNameDescriptionResponse
Roblox.GameInternationalization.Api.UpdateGamePassNameRequest
Roblox.GameInternationalization.Api.UpdateGamePassNameResponse
Roblox.GameInternationalization.Api.UpdateNameDescriptionsRequest
Roblox.GameInternationalization.Api.UpdateNameDescriptionsResponse
Roblox.GameInternationalization.Api.UpdateThumbnailAltTextRequest
Roblox.GameInternationalization.Api.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse
Roblox.GameLocalization.Client.GameLocalizationRoles.Assignee
Roblox.GameLocalization.Client.GameLocalizationRoles.GameLocalizationRoleAssignment
Roblox.GameLocalization.Client.UserUniverseLocalizationSettingValue
Roblox.Games.Api.Models.Response.GameContentMetadataResponseModel
Roblox.Games.Api.Models.Response.GameRecommendationsResponse
Roblox.Games.Api.Models.Response.PrivatePlaytestInfoResponse
Roblox.ItemConfiguration.Api.Models.Request.PublishingPreferences.CreatePublishingPreferencesRequest
Roblox.ItemConfiguration.Api.Models.Request.PublishingPreferences.UpdatePublishingPreferencesRequest
Roblox.ItemConfiguration.Api.Models.Response.PublishingPreferences.PublishingPreferencesResponse
Roblox.LocalizationTables.Api.AutoLocalizationMetadataResponse
Roblox.LocalizationTables.Api.EntryIdentifierWithTranslation
Roblox.LocalizationTables.Api.FailedEntryTranslationHistoryPaged
Roblox.LocalizationTables.Api.GameAutolocalizationInformationResponse
Roblox.LocalizationTables.Api.GetTableAssetEntriesPagedResponse
Roblox.LocalizationTables.Api.GetTableEntriesTranslationFeedbackRequest
Roblox.LocalizationTables.Api.GetTableEntriesTranslationFeedbackResponse
Roblox.LocalizationTables.Api.GetTableEntriesTranslationHistoryRequest
Roblox.LocalizationTables.Api.GetTableEntriesTranslationHistoryResponse
Roblox.LocalizationTables.Api.LocalizationTablesMetadataResponse
Roblox.LocalizationTables.Api.RaiseEventForAutoScrapedEntriesCleanupRequest
Roblox.LocalizationTables.Api.SetAutolocalizationSettingsForGameRequest
Roblox.LocalizationTables.Api.SetAutolocalizationTableForGameRequest
Roblox.Platform.UniverseSettings.UniverseAvatarAssetOverrideResponseModel
Roblox.Platform.UserPhoneNumberVerification.Models.PendingVerificationResponse
Roblox.PrivateMessages.Api.Models.AnnouncementsDetailsResponse
Roblox.PrivateMessages.Api.Models.AnnouncementsMetadataResponse
Roblox.PrivateMessages.Api.Models.UnreadMessagesCountResponse
Roblox.PrivateMessages.Api.Models.VerifiedSkinnyUserResponse
Roblox.Trades.Api.Models.V2.CurrencyTransferEligibilityResponse
Roblox.TranslationRoles.Api.GetGameLocalizationRoleAssignmentsForUserResponse
Roblox.TwoStepVerification.Api.DisableTwoStepVerificationRequest
Roblox.TwoStepVerification.Api.EnableTwoStepVerificationRequest
Roblox.TwoStepVerification.Api.EnableVerifyAuthenticatorRequest
Roblox.TwoStepVerification.Api.EnableVerifyAuthenticatorResponse
Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest
Roblox.TwoStepVerification.Api.Models.Request.SecureAuthenticationIntentModel
Roblox.TwoStepVerification.Api.RegenerateRecoveryCodesRequest
Roblox.TwoStepVerification.Api.RegenerateRecoveryCodesResponse
Roblox.TwoStepVerification.Api.VerifyStartSecurityKeyResponse
Roblox.UniversePluginPermissionAuthority.Models.UniversePluginPermissions
Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_
Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Badges.BadgeAwarderType_
Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Core.CreatorType_
Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Users.Client.AssociatedEntityType_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.GameTemplateModel_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.GroupModel_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.UniverseIdPermissionsModel_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.UniverseModel_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.UniverseTeamCreateSettingsModel_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItemV2_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Friends.Api.FriendStatusResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetBadgeIconResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetGameIconResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.LanguageOrLocale_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.LanguageWithLocales_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.NameDescription_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Games.Api.Models.Response.GameDetailResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Games.Api.Models.Response.GameProductResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Locale.Api.SupportedLocaleLocus_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.TranslationRoles.Api.Assignee_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Users.Api.MultiGetUserByNameResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Users.Api.MultiGetUserResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Web.Responses.Games.GameMediaItemResponseV2_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Web.Responses.Plugins.PluginResponse_
Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Web.Responses.Users.SkinnyUserResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Api.Develop.Models.IPlaceModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Api.Develop.Models.UniverseModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.BadgeResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Catalog.Api.BundleDetailsModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Catalog.Api.CatalogSearchDetailedResponseItem_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Catalog.Api.OwnedBundleModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Friends.Api.FriendRequestResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.CollectibleUserAssetModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.IItemModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.InventoryItemModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.PlaceModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.V2.AssetOwnerResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.V2.CollectibleItemOwnerResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.V2.UserAssetItemModelV2_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Trades.Api.TradeResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.UsernameHistoryResponse_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Web.Responses.Games.GameFavoriteResponseModel_
Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Web.Responses.Games.GameResponseV2_
TranslationRolesApi.Roblox.Web.WebAPI.Models.ApiArrayResponse_System.String_
Other Components
components/requestBodies/Roblox.AccountInformation.Api.Models.PhoneRequest
components/requestBodies/Roblox.Api.Develop.Models.PlaceConfigurationModel
components/requestBodies/Roblox.Api.Develop.Models.TeamCreateMembershipRequest
components/requestBodies/Roblox.Api.Develop.Models.UpdateTeamCreateSettingsRequest
components/requestBodies/Roblox.Authentication.Api.Models.SignupRequest
components/requestBodies/Roblox.PrivateMessages.Api.Models.BatchMessagesRequest
components/requestBodies/Roblox.Trades.Api.Models.V2.TradeRequest
components/requestBodies/Roblox.TwoStepVerification.Api.DisableTwoStepVerificationRequest
components/requestBodies/Roblox.TwoStepVerification.Api.EnableTwoStepVerificationRequest
components/requestBodies/Roblox.TwoStepVerification.Api.SendCodeRequest
components/requestBodies/Roblox.TwoStepVerification.Api.SendCodeRequest2
components/requestBodies/Roblox.TwoStepVerification.Api.VerifyCodeRequest
components/requestBodies/Roblox.TwoStepVerification.Api.VerifyCodeRequest2
components/requestBodies/Roblox.TwoStepVerification.Api.VerifyCodeRequest3
components/requestBodies/postV1Badges_badgeid_iconsLanguageCodes_languagecode_
API Metadata
{
"openapi": "3.0.4",
"info": {
"title": "Roblox API",
"description": "The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.",
"version": "1.0.0",
"x-roblox-extensions-version": "1.1.0"
},
"servers": [
{
"url": "https://apis.roblox.com"
}
],
"tags": [
{
"name": "Accounts",
"description": "Access and manage Roblox account information.\n",
"x-roblox-tag-info": {
"path": "accounts",
"content": "HTTP APIs for working with accounts on Roblox Cloud.",
"ordering": [
"accountinformation_get_v1_birthdate",
"accountinformation_get_v1_description",
"accountinformation_post_v1_description",
"accountinformation_post_v1_email_verify",
"accountinformation_get_v1_gender",
"accountinformation_post_v1_gender",
"accountinformation_get_v1_metadata",
"accountinformation_get_v1_phone",
"accountinformation_post_v1_phone",
"accountinformation_post_v1_phone_delete",
"accountinformation_post_v1_phone_resend",
"accountinformation_post_v1_phone_verify",
"accountinformation_get_v1_promotion_channels",
"accountinformation_post_v1_promotion_channels",
"accountinformation_get_v1_users__userId__promotion_channels",
"accountinformation_get_v1_users__userId__roblox_badges",
"users_get_v1_birthdate",
"users_post_v1_birthdate",
"users_get_v1_description",
"users_post_v1_description",
"users_get_v1_gender",
"users_post_v1_gender",
"users_get_v1_users_authenticated",
"users_get_v1_users_authenticated_age_bracket",
"users_get_v1_users_authenticated_country_code",
"users_get_v1_users_authenticated_roles",
"auth_delete_v1_account_pin",
"auth_get_v1_account_pin",
"auth_patch_v1_account_pin",
"auth_post_v1_account_pin",
"auth_post_v1_account_pin_lock",
"auth_post_v1_account_pin_unlock",
"auth_get_v1_auth_metadata",
"auth_get_v1_client_assertion",
"auth_get_v1_external__identityProviderId__sso_oauth_callback",
"auth_post_v1_external__identityProviderId__sso_oauth_callback",
"auth_get_v1_external__identityProviderId__sso_oauth_init",
"auth_post_v1_external__identityProviderId__sso_native_nonce",
"auth_post_v1_external__identityProviderId__sso_saml_assertion_consumer_service",
"auth_post_v1_external_access",
"auth_post_v1_external_login",
"auth_post_v1_external_loginAndLink",
"auth_post_v1_external_signup",
"auth_post_v1_external_unlink",
"auth_post_v1_identity_verification_login",
"auth_post_v1_identity_initialize_login",
"auth_post_v1_login",
"auth_post_v1_login_linked",
"auth_post_v1_logout",
"auth_post_v1_logoutfromallsessionsandreauthenticate",
"auth_get_v1_metadata",
"auth_post_v1_passkey_DeleteCredentialBatch",
"auth_post_v1_passkey_RenameCredential",
"auth_post_v1_passkey_finish_preauth_registration",
"auth_post_v1_passkey_FinishRegistration",
"auth_post_v1_passkey_ListCredentials",
"auth_post_v1_passkey_start_authentication_by_user",
"auth_post_v1_passkey_start_preauth_registration",
"auth_post_v1_passkey_finish_ar_preauth_registration",
"auth_post_v1_passkey_StartAuthentication",
"auth_post_v1_passkey_StartRegistration",
"auth_get_v1_passwords_validate",
"auth_post_v1_passwords_validate",
"auth_get_v1_recovery_metadata",
"auth_get_v1_revert_account",
"auth_post_v1_revert_account",
"auth_post_v2_revert_invalidate_tickets",
"auth_post_v1_revert_invalidate_tickets",
"auth_post_v1_session_refresh",
"auth_post_v1_signup",
"auth_post_v1_signup_linked",
"auth_post_v1_social__provider__disconnect",
"auth_get_v1_social_connected_providers",
"auth_post_v1_user_passwords_change",
"auth_post_v1_username",
"auth_get_v1_usernames",
"auth_post_v1_usernames_recover",
"auth_get_v1_usernames_validate",
"auth_post_v1_usernames_validate",
"auth_get_v1_validators_email",
"auth_get_v1_validators_recommendedUsernameFromDisplayName",
"auth_post_v1_validators_recommendedUsernameFromDisplayName",
"auth_get_v1_validators_username",
"auth_post_v1_validators_username",
"auth_get_v1_xbox_connection",
"auth_post_v1_xbox_disconnect",
"auth_get_v1_xbox_get_login_consecutive_days",
"auth_get_v1_username_change_price",
"auth_get_v1_account_creation_metadata",
"auth_get_v1_passkey_su_eligibility",
"auth_post_v1_xbox_translate",
"auth_get_v2_auth_metadata",
"auth_post_v2_identity_verification_login",
"auth_post_v2_login",
"auth_post_v2_login_linked",
"auth_post_v2_logout",
"auth_post_v2_logoutfromallsessionsandreauthenticate",
"auth_get_v2_metadata",
"auth_get_v2_passwords_current_status",
"auth_get_v2_passwords_reset",
"auth_post_v2_passwords_reset",
"auth_post_v2_passwords_reset_send",
"auth_post_v2_passwords_reset_verify",
"auth_get_v2_passwords_validate",
"auth_post_v2_passwords_validate",
"auth_get_v2_recovery_metadata",
"auth_get_v2_revert_account",
"auth_post_v2_revert_account",
"auth_post_v2_session_refresh",
"auth_post_v2_signup",
"auth_post_v2_signup_linked",
"auth_post_v2_user_passwords_change",
"auth_post_v2_username",
"auth_get_v2_usernames",
"auth_post_v2_usernames_recover",
"auth_get_v2_usernames_validate",
"auth_get_v2_username_change_price",
"auth_post_v2_usernames_validate",
"auth_post_v3_logout",
"auth_post_v3_users__userId__two_step_verification_login",
"games_get_v1_games_multiget_playability_status",
"inventory_get_v1_users__userId__can_view_inventory",
"notifications_get_v2_push_notifications_get_destinations",
"privatemessages_get_v1_announcements",
"privatemessages_get_v1_announcements_metadata",
"privatemessages_get_v1_messages",
"privatemessages_get_v1_messages__messageId_",
"privatemessages_post_v1_messages_archive",
"privatemessages_post_v1_messages_mark_read",
"privatemessages_post_v1_messages_mark_unread",
"privatemessages_post_v1_messages_unarchive",
"privatemessages_get_v1_messages_unread_count",
"twostepverification_get_v1_metadata",
"twostepverification_post_v1_users__userId__challenges_authenticator_verify",
"twostepverification_post_v1_users__userId__challenges_cross_device_retract",
"twostepverification_post_v1_users__userId__challenges_cross_device_retry",
"twostepverification_post_v1_users__userId__challenges_cross_device_verify",
"twostepverification_post_v1_users__userId__challenges_email_send_code",
"twostepverification_post_v1_users__userId__challenges_email_verify",
"twostepverification_post_v1_users__userId__challenges_passkey_verify_finish",
"twostepverification_post_v1_users__userId__challenges_passkey_verify_start",
"twostepverification_post_v1_users__userId__challenges_password_verify",
"twostepverification_post_v1_users__userId__challenges_recovery_codes_verify",
"twostepverification_post_v1_users__userId__challenges_security_key_verify_finish",
"twostepverification_post_v1_users__userId__challenges_security_key_verify_start",
"twostepverification_post_v1_users__userId__challenges_sms_send_code",
"twostepverification_post_v1_users__userId__challenges_sms_verify",
"twostepverification_get_v1_users__userId__configuration",
"twostepverification_post_v1_users__userId__configuration_authenticator_disable",
"twostepverification_post_v1_users__userId__configuration_authenticator_enable",
"twostepverification_post_v1_users__userId__configuration_authenticator_enable_verify",
"twostepverification_post_v1_users__userId__configuration_email_disable",
"twostepverification_post_v1_users__userId__configuration_email_enable",
"twostepverification_post_v1_users__userId__configuration_security_key_disable",
"twostepverification_post_v1_users__userId__configuration_security_key_enable",
"twostepverification_post_v1_users__userId__configuration_security_key_enable_verify",
"twostepverification_post_v1_users__userId__configuration_security_key_list",
"twostepverification_post_v1_users__userId__configuration_sms_disable",
"twostepverification_post_v1_users__userId__configuration_sms_enable",
"twostepverification_get_v1_users__userId__recovery_codes",
"twostepverification_post_v1_users__userId__recovery_codes_clear",
"twostepverification_post_v1_users__userId__recovery_codes_regenerate"
]
}
},
{
"name": "Advertising",
"description": "Create and manage advertising on Roblox. Experience advertising drives engagement to your experiences through the Ads API, and item advertising promotes Marketplace items through sponsored campaigns. See the [Advertising guide](https://create.roblox.com/docs/cloud/guides/advertising) for Open Cloud setup and usage.\n",
"x-roblox-tag-info": {
"path": "advertising",
"content": "HTTP APIs for creating and managing advertising on Roblox Cloud.",
"ordering": [
"get_ads_management_v1_billing_accounts",
"get_ads_management_v1_billing_accounts__id_",
"get_ads_management_v1_advertisable_universes",
"get_ads_management_v1_campaign_options",
"get_ads_management_v1_campaigns",
"post_ads_management_v1_campaigns",
"get_ads_management_v1_campaigns__id_",
"patch_ads_management_v1_campaigns__id_",
"post_ads_management_v1_campaigns_batchGetStatus",
"get_ads_management_v1_creatives",
"adconfiguration_get_v2_sponsored_campaigns",
"adconfiguration_post_v2_sponsored_campaigns_create",
"adconfiguration_get_v2_sponsored_campaigns_eligible_asset_type_ids",
"adconfiguration_post_v2_sponsored_campaigns_eligible_campaign_targets",
"adconfiguration_get_v2_sponsored_campaigns_multi_get_can_user_sponsor",
"adconfiguration_post_v2_sponsored_campaigns_stop",
"adconfiguration_get_v2_sponsored_games",
"adconfiguration_get_v2_sponsored_games_universes",
"adconfiguration_post_v2_sponsored_games_create",
"adconfiguration_post_v2_sponsored_games_stop"
]
}
},
{
"name": "Analytics",
"description": "Query analytics data and manage analytics alerts for your experiences programmatically. See the [Analytics guide](https://create.roblox.com/docs/cloud/guides/analytics) for Open Cloud setup and usage.\n",
"x-roblox-tag-info": {
"path": "analytics",
"content": "HTTP APIs for querying experience analytics and managing analytics alerts on Roblox Cloud",
"ordering": [
"post_analytics_query_api_v1_universes__universe_id__metrics",
"post_analytics_query_api_v1_universes__universe_id__dimension_values",
"get_analytics_query_api_v1_universes__universe_id__operations_metrics__operation_id_",
"get_analytics_query_api_v1_universes__universe_id__operations_dimension_values__operation_id_"
]
}
},
{
"name": "Assets",
"description": "Upload, update, and manage assets programmatically. Supported asset types include Audio, Decals, Images, Models, Meshes, and Videos. For detailed implementation, see the [Assets Usage Guide](/cloud/guides/usage-assets).\n\nCommon use cases include:\n\n- Asset creation: [Create an asset](#Assets_CreateAsset), then [poll the operation endpoint](#Assets_GetOperation) for completion\n- Asset retrieval: [Retrieve asset content](#get_asset_delivery_api_v1_assetId__assetId_) or [a specific version of it](#get_asset_delivery_api_v1_assetId__assetId__version__versionNumber_) for external tools\n- Versioning: [Manage asset versions](#listAssetVersions) with [rollback](#Assets_RollbackAssetVersion) support\n",
"x-roblox-tag-info": {
"path": "assets",
"content": "HTTP APIs for working with assets on Roblox Cloud.",
"ordering": [
"Assets_CreateAsset",
"Assets_GetAsset",
"Assets_UpdateAsset",
"Assets_ArchiveAsset",
"Assets_RestoreAsset",
"listAssetVersions",
"Assets_RollbackAssetVersion",
"Assets_GetAssetVersion",
"Assets_GetOperation",
"Cloud_GenerateSpeechAsset",
"Cloud_ListAssetQuotas",
"get_legacy_localization_tables_v1_localization_table_tables__assetId_",
"localizationtables_get_v1_localization_table_tables__assetId_",
"post_legacy_publish_v1_badges__badgeId__icon",
"publish_post_v1_badges__badgeId__icon",
"Toolbox_SearchCreatorStoreAssetsDeprecated",
"Toolbox_GetAssetDetails",
"patch_asset_permissions_api_v1_assets_permissions",
"assetdelivery_get_v1_asset",
"assetdelivery_get_v1_assetId__assetId_",
"assetdelivery_get_v1_assetId__assetId__version__versionNumber_",
"assetdelivery_post_v1_assets_batch",
"assetdelivery_get_v1_marAssetHash__marAssetHash__marCheckSum__marCheckSum_",
"assetdelivery_get_v2_asset",
"assetdelivery_get_v2_assetId__assetId_",
"assetdelivery_get_v2_assetId__assetId__version__versionNumber_",
"assetdelivery_post_v2_assets_batch",
"assetdelivery_get_v2_marAssetHash__marAssetHash__marCheckSum__marCheckSum_",
"avatar_get_v1_users__userId__currently_wearing",
"catalog_get_v1_assets__assetId__bundles",
"catalog_get_v1_bundles__bundleId__details",
"catalog_get_v1_bundles_details",
"catalog_post_v1_catalog_items_details",
"catalog_get_v1_favorites_assets__assetId__count",
"catalog_get_v1_favorites_bundles__bundleId__count",
"catalog_get_v1_favorites_users__userId__favorites__assetTypeId__assets",
"catalog_get_v1_users__userId__bundles__bundleType_",
"catalog_get_v2_search_items_details",
"develop_get_v1_plugins",
"develop_patch_v1_plugins__pluginId_",
"develop_get_v1_user_groups_canmanagegamesoritems",
"inventory_get_v1_users__userId__items__itemType___itemTargetId_",
"inventory_get_v2_assets__assetId__owners",
"inventory_get_v2_collectible_items__collectibleItemId__owners",
"inventory_delete_v2_inventory_asset__assetId_",
"inventory_get_v2_users__userId__inventory",
"itemconfiguration_get_v1_preferences_publishing",
"itemconfiguration_post_v1_preferences_publishing",
"itemconfiguration_patch_v1_preferences_publishing",
"itemconfiguration_delete_v1_preferences_publishing",
"thumbnails_get_v1_asset_thumbnail_animated",
"thumbnails_get_v1_assets",
"thumbnails_get_v1_assets_thumbnail_3d"
]
}
},
{
"name": "Avatars",
"description": "Customize user avatars and manage outfits programmatically, including [retrieving a user's avatar configuration](#avatar_get_v4_avatar_users__userId_), body colors, scales, [thumbnail generation](#Cloud_GenerateUserThumbnail), and [thumbnail generation operation retrieval](#Cloud_GetUserThumbnailGenerationOperation).\n",
"x-roblox-tag-info": {
"path": "avatars",
"content": "HTTP APIs for working with avatars on Roblox Cloud.",
"ordering": [
"Cloud_GenerateUserThumbnail",
"Cloud_GetUserThumbnailGenerationOperation",
"avatar_get_v1_avatar",
"avatar_get_v1_avatar_rules",
"avatar_get_v1_avatar_metadata",
"avatar_post_v1_avatar_redraw_thumbnail",
"avatar_post_v1_avatar_set_body_colors",
"avatar_post_v1_avatar_set_player_avatar_type",
"avatar_post_v1_avatar_set_scales",
"avatar_get_v1_game_start_info",
"avatar_post_v1_outfits__userOutfitId__delete",
"avatar_get_v1_outfits__userOutfitId__details",
"avatar_get_v1_users__userId__avatar",
"avatar_get_v1_users__userId__currently_wearing",
"avatar_get_v1_users__userId__outfits",
"avatar_patch_v2_avatar",
"avatar_get_v2_avatar_avatar",
"avatar_post_v2_avatar_set_body_colors",
"avatar_post_v2_avatar_set_wearing_assets",
"avatar_get_v2_avatar_users__userId__avatar",
"avatar_get_v2_avatar_users__userId__outfits",
"avatar_patch_v2_outfits__userOutfitId_",
"avatar_post_v2_outfits_create",
"avatar_patch_v3_outfits__userOutfitId_",
"avatar_get_v3_outfits__userOutfitId__details",
"avatar_post_v3_outfits_create",
"avatar_get_v4_avatar",
"avatar_patch_v4_avatar",
"avatar_get_v4_avatar_users__userId_",
"avatar_post_v4_outfits_create",
"avatar_patch_v4_outfits__outfitId_",
"avatar_get_v4_outfits__outfitId__details",
"catalog_get_v1_assets__assetId__bundles",
"catalog_get_v1_bundles__bundleId__details",
"catalog_get_v1_bundles_details",
"catalog_post_v1_catalog_items_details",
"catalog_get_v1_favorites_assets__assetId__count",
"catalog_get_v1_favorites_bundles__bundleId__count",
"catalog_get_v1_favorites_users__userId__favorites__assetTypeId__assets",
"catalog_get_v1_users__userId__bundles__bundleType_",
"catalog_get_v2_search_items_details",
"thumbnails_get_v1_bundles_thumbnails",
"thumbnails_get_v1_users_avatar",
"thumbnails_get_v1_users_avatar_3d",
"thumbnails_get_v1_users_avatar_bust",
"thumbnails_get_v1_users_avatar_headshot"
]
}
},
{
"name": "Badges",
"description": "Create and manage experience badges to recognize player achievements. [Create](#post_legacy_badges_v1_universes__universeId__badges) and [update](#patch_legacy_badges_v1_badges__badgeId_) badges with custom icons, and [track which badges users have earned](#badges_get_v1_users__userId__badges_awarded_dates) and when they were awarded.\n",
"x-roblox-tag-info": {
"path": "badges",
"content": "HTTP APIs for working with badges on Roblox Cloud.",
"ordering": [
"patch_legacy_badges_v1_badges__badgeId_",
"badges_patch_v1_badges__badgeId_",
"post_legacy_badges_v1_universes__universeId__badges",
"badges_post_v1_universes__universeId__badges",
"patch_legacy_game_internationalization_v1_badges__badgeId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_badges__badgeId__icons",
"gameinternationalization_get_v1_badges__badgeId__icons",
"delete_legacy_game_internationalization_v1_badges__badgeId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_badges__badgeId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_badges__badgeId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_badges__badgeId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_badges__badgeId__name_description",
"gameinternationalization_get_v1_badges__badgeId__name_description",
"delete_legacy_game_internationalization_v1_badges__badgeId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_badges__badgeId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_badges__badgeId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_badges__badgeId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__name_language_codes__languageCode_",
"post_legacy_publish_v1_badges__badgeId__icon",
"publish_post_v1_badges__badgeId__icon",
"accountinformation_get_v1_users__userId__roblox_badges",
"badges_get_v1_badges__badgeId_",
"badges_get_v1_badges_metadata",
"badges_get_v1_universes__universeId__badges",
"badges_get_v1_universes__universeId__free_badges_quota",
"badges_delete_v1_user_badges__badgeId_",
"thumbnails_get_v1_badges_icons"
]
}
},
{
"name": "Bans and blocks",
"description": "Manage user restrictions using the Ban API, which includes real-time alt account detection. [Universe-level bans](#Cloud_UpdateUserRestriction__Using_Universes) affect all places, while [place-level bans](#Cloud_UpdateUserRestriction__Using_Universes_Places) allow granular control. Bans can also be managed via the Creator Hub dashboard.\n\nBan users with customizable duration and reasons, and [review moderation history](#Cloud_ListUserRestrictionLogs) for any banned users.\n",
"x-roblox-tag-info": {
"path": "bans-and-blocks",
"content": "HTTP APIs for working with bans and blocks on Roblox Cloud.",
"ordering": [
"Cloud_ListUserRestrictions__Using_Universes",
"Cloud_GetUserRestriction__Using_Universes_Places",
"Cloud_UpdateUserRestriction__Using_Universes_Places",
"Cloud_ListUserRestrictions",
"Cloud_ListUserRestrictionLogs",
"Cloud_GetUserRestriction__Using_Universes",
"Cloud_UpdateUserRestriction__Using_Universes"
]
}
},
{
"name": "Configs",
"description": "Manage your in-experience config values in real time without restarting servers. See the [Configs guide](https://create.roblox.com/docs/cloud/guides/configs) for Open Cloud setup and usage.\n",
"x-roblox-tag-info": {
"path": "configs",
"content": "HTTP APIs for working with creator configs on Roblox Cloud",
"ordering": [
"CreatorConfigsPublicApi_GetConfigRepositoryFull",
"CreatorConfigsPublicApi_GetConfigRepositoryValues",
"CreatorConfigsPublicApi_GetConfigRepositoryDraft",
"CreatorConfigsPublicApi_UpdateDraft",
"CreatorConfigsPublicApi_DeleteDraft",
"CreatorConfigsPublicApi_OverwriteDraft",
"CreatorConfigsPublicApi_PublishDraft",
"CreatorConfigsPublicApi_ListRevisions",
"CreatorConfigsPublicApi_RestoreRevision"
]
}
},
{
"name": "Connections",
"description": "Manage user connections, such as [viewing pending trusted friend requests](#friends_get_v1_my_trusted_friends_requests), [retrieving the pending trusted friend request count](#friends_get_v1_user_trusted_friend_requests_count), [declining all connection requests](#friends_post_v1_users__requesterUserId__decline_friend_request), or [retrieving a connection list](#friends_get_v1_users__userId__friends).\n",
"x-roblox-tag-info": {
"path": "friends",
"content": "HTTP APIs for working with connections on Roblox Cloud.",
"ordering": [
"friends_get_v1_my_friends_count",
"friends_get_v1_my_friends_requests",
"friends_get_v1_my_new_friend_requests_count",
"friends_get_v1_my_trusted_friends_requests",
"friends_get_v1_user_trusted_friend_requests_count",
"friends_get_v1_user_friend_requests_count",
"friends_get_v1_users__userId__friends_statuses",
"Presence_GetUserPresences"
]
}
},
{
"name": "Creator Store",
"description": "Manage your presence on the [Creator Store](/production/creator-store). [Create](#Cloud_CreateCreatorStoreProduct) and [update](#Cloud_UpdateCreatorStoreProduct) product listings for your assets, and [search the toolbox](#Toolbox_SearchCreatorStoreAssets) for assets using various filters.\n",
"x-roblox-tag-info": {
"path": "creator-store",
"content": "HTTP APIs for working with the Creator Store on Roblox Cloud.",
"ordering": [
"Cloud_CreateCreatorStoreProduct",
"Cloud_GetCreatorStoreProduct",
"Cloud_UpdateCreatorStoreProduct",
"Toolbox_SearchCreatorStoreAssetsDeprecated",
"Toolbox_SearchCreatorStoreAssets",
"Toolbox_GetAssetDetails",
"Saves_GetSaves",
"Saves_CreateSave",
"Saves_DeleteSave",
"Saves_BulkDeleteSaves",
"itemconfiguration_get_v1_preferences_publishing",
"itemconfiguration_post_v1_preferences_publishing",
"itemconfiguration_patch_v1_preferences_publishing",
"itemconfiguration_delete_v1_preferences_publishing"
]
}
},
{
"name": "Data and memory stores",
"description": "Manage persistent player data using standard data stores, ordered data stores, and memory stores. See the [Data Stores Guide](/cloud/guides/data-stores) for implementation examples.\n\nCommon use cases include:\n\n- **Player Data Management**: [Store](#Cloud_CreateDataStoreEntry__Using_Universes) and [retrieve](#Cloud_GetDataStoreEntry__Using_Universes_DataStores) player profiles, inventories, and progress\n- **Leaderboards**: Use [ordered data stores](#Cloud_ListOrderedDataStoreEntries) to create global or per-experience leaderboards sorted by score\n- **Customer Support Tools**: Build external portals to [view](#Cloud_GetDataStoreEntry__Using_Universes_DataStores) and [modify](#Cloud_UpdateDataStoreEntry__Using_Universes_DataStores) player data\n",
"x-roblox-tag-info": {
"path": "storage",
"content": "HTTP APIs for working with data and memory stores on Roblox Cloud.",
"ordering": [
"Cloud_ListDataStores",
"Cloud_DeleteDataStore",
"Cloud_UndeleteDataStore",
"Cloud_SnapshotDataStores",
"Cloud_ListDataStoreEntries__Using_Universes",
"Cloud_CreateDataStoreEntry__Using_Universes",
"Cloud_DeleteDataStoreEntry__Using_Universes_DataStores",
"Cloud_GetDataStoreEntry__Using_Universes_DataStores",
"Cloud_UpdateDataStoreEntry__Using_Universes_DataStores",
"Cloud_IncrementDataStoreEntry__Using_Universes_DataStores",
"Cloud_ListDataStoreEntryRevisions__Using_Universes_DataStores",
"Cloud_ListDataStoreEntries__Using_Universes_DataStores",
"Cloud_CreateDataStoreEntry__Using_Universes_DataStores",
"Cloud_DeleteDataStoreEntry__Using_Universes_DataStores_Scopes",
"Cloud_GetDataStoreEntry__Using_Universes_DataStores_Scopes",
"Cloud_UpdateDataStoreEntry__Using_Universes_DataStores_Scopes",
"Cloud_IncrementDataStoreEntry__Using_Universes_DataStores_Scopes",
"Cloud_ListDataStoreEntryRevisions__Using_Universes_DataStores_Scopes",
"Cloud_FlushMemoryStore",
"Cloud_GetMemoryStoreFlushOperation",
"Cloud_CreateMemoryStoreQueueItem",
"Cloud_DiscardMemoryStoreQueueItems",
"Cloud_ReadMemoryStoreQueueItems",
"Cloud_ListMemoryStoreSortedMapItems",
"Cloud_CreateMemoryStoreSortedMapItem",
"Cloud_DeleteMemoryStoreSortedMapItem",
"Cloud_GetMemoryStoreSortedMapItem",
"Cloud_UpdateMemoryStoreSortedMapItem",
"Cloud_ListOrderedDataStoreEntries",
"Cloud_CreateOrderedDataStoreEntry",
"Cloud_DeleteOrderedDataStoreEntry",
"Cloud_GetOrderedDataStoreEntry",
"Cloud_UpdateOrderedDataStoreEntry",
"Cloud_IncrementOrderedDataStoreEntry",
"Datastores_ListDatastoresAsync",
"Entries_ListKeysAsync",
"Entries_DeleteEntryAsync",
"Entries_GetEntryAsync",
"Entries_SetEntryAsync",
"Entries_IncrementEntryAsync",
"Entries_ListEntryVersionsAsync",
"Entries_GetEntryVersionAsync",
"OrderedDataStores_ListEntries",
"OrderedDataStores_CreateEntry",
"OrderedDataStores_DeleteEntry",
"OrderedDataStores_GetEntry",
"OrderedDataStores_UpdateEntry",
"OrderedDataStores_IncrementEntry"
]
}
},
{
"name": "Developer products",
"description": "Create and manage developer products for repeatable in-experience purchases like in-game currency, consumables, or temporary boosts. [Create](#DeveloperProducts_CreateDeveloperProductV2) and [update](#DeveloperProducts_UpdateDeveloperProductV2) products with custom icons and pricing, and [add localized names and descriptions](#patch_legacy_game_internationalization_v1_developer_products__developerProductId__description_language_codes__languageCode_) for different languages.\n",
"x-roblox-tag-info": {
"path": "developer-products",
"content": "HTTP APIs for working with developer products on Roblox Cloud.",
"ordering": [
"DeveloperProducts_CreateDeveloperProductV2",
"DeveloperProducts_UpdateDeveloperProductV2",
"DeveloperProducts_GetDeveloperProductConfigV2",
"DeveloperProducts_ListDeveloperProductConfigsByUniverseV2",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_developer_products__developerProductId__icons",
"gameinternationalization_get_v1_developer_products__developerProductId__icons",
"delete_legacy_game_internationalization_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_developer_products__developerProductId__name_description",
"gameinternationalization_get_v1_developer_products__developerProductId__name_description",
"delete_legacy_game_internationalization_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__name_language_codes__languageCode_",
"thumbnails_get_v1_developer_products_icons"
]
}
},
{
"name": "Experiments",
"description": "Manage and analyze experiments for your experiences programmatically. See the [Experiments guide](https://create.roblox.com/docs/production/experiments) for setup and usage.\n",
"x-roblox-tag-info": {
"path": "experiments",
"content": "HTTP APIs for managing experience experiments on Roblox Cloud",
"ordering": [
"PublicExperimentation_CreateExperiment",
"PublicExperimentation_GetExperiment",
"PublicExperimentation_UpdateExperiment",
"PublicExperimentation_DiscardExperiment",
"PublicExperimentation_ListExperiments",
"PublicExperimentation_GetExperimentOperationStatus",
"PublicExperimentation_StartExperiment",
"PublicExperimentation_ScheduleExperiment",
"PublicExperimentation_CompleteExperiment",
"PublicExperimentation_CalculateExperimentMde",
"PublicExperimentation_GetExperimentStats"
]
}
},
{
"name": "Game Events",
"description": "Create and manage scheduled game events for a universe — announce content\nupdates, drops, and live moments, and let players discover and RSVP to them.\n\nCommon use cases include:\n\n- **Create an event**: Publish a game event for a universe with a title, schedule, visibility, categories, and thumbnails\n- **List and read events**: Page through a universe's game events or fetch a single event, using an optional `fields` mask to trim the payload\n- **Update or cancel**: Patch event details or delete a game event\n",
"x-roblox-tag-info": {
"path": "virtual-events",
"content": "HTTP APIs for creating and managing game events for a universe on Roblox.",
"ordering": [
"GameEvents_List",
"GameEvents_Create",
"GameEvent_Get",
"GameEvent_Update",
"GameEvent_Delete"
]
}
},
{
"name": "Game passes",
"description": "Create and manage game passes to monetize your experiences. Game passes provide one-time purchases that grant permanent benefits to players. [Create](#GamePasses_CreateGamePass) and [update](#GamePasses_UpdateGamePass) game passes with custom icons and pricing, and [list all game passes](#GamePasses_ListGamePassConfigsByUniverse) for an experience.\n",
"x-roblox-tag-info": {
"path": "game-passes",
"content": "HTTP APIs for working with game passes on Roblox Cloud.",
"ordering": [
"GamePasses_CreateGamePass",
"GamePasses_UpdateGamePass",
"GamePasses_GetGamePassConfig",
"GamePasses_ListGamePassConfigsByUniverse",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_game_passes__gamePassId__icons",
"gameinternationalization_get_v1_game_passes__gamePassId__icons",
"delete_legacy_game_internationalization_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_game_passes__gamePassId__name_description",
"gameinternationalization_get_v1_game_passes__gamePassId__name_description",
"delete_legacy_game_internationalization_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__name_language_codes__languageCode_",
"thumbnails_get_v1_game_passes"
]
}
},
{
"name": "Generative AI",
"description": "Access Roblox's generative AI capabilities for content creation and translation. These APIs enable you to [translate in-game text](#Cloud_TranslateText) between supported languages and [generate speech audio assets](#Cloud_GenerateSpeechAsset) from text for NPC dialogue or narration.\n",
"x-roblox-tag-info": {
"path": "generative-ai",
"content": "HTTP APIs related to Generative AI and LLMs on Open Cloud.",
"ordering": [
"Cloud_TranslateText",
"Cloud_GenerateSpeechAsset"
]
}
},
{
"name": "Groups",
"description": "Manage Roblox groups including memberships, roles, and group settings.\n\nCommon use cases include:\n\n- Membership management: [Accept](#Cloud_AcceptGroupJoinRequest) or [decline](#Cloud_DeclineGroupJoinRequest) join requests and [manage member roles](#Cloud_UpdateGroupMembership)\n- Role configuration: [Create](#groups_post_v1_groups__groupId__rolesets_create), [update](#groups_patch_v1_groups__groupId__rolesets__rolesetId_), and [delete](#groups_delete_v1_groups__groupId__rolesets__rolesetId_) group roles with custom permissions\n- Audit logging: [Review group activity](#get_legacy_groups_v1_groups__groupId__audit_log) through audit logs\n",
"x-roblox-tag-info": {
"path": "groups",
"content": "HTTP APIs for working with groups on Roblox Cloud.",
"ordering": [
"Cloud_GetGroup",
"Cloud_ListGroupJoinRequests",
"Cloud_AcceptGroupJoinRequest",
"Cloud_DeclineGroupJoinRequest",
"Cloud_ListGroupMemberships",
"Cloud_UpdateGroupMembership",
"Cloud_AssignRoleGroupMembership",
"Cloud_UnassignRoleGroupMembership",
"Cloud_ListGroupRoles",
"Cloud_GetGroupRole",
"Cloud_ListGroupForumCategories",
"Cloud_ListGroupForumPosts",
"Cloud_ListGroupForumComments",
"get_legacy_develop_v1_user_groups_canmanage",
"develop_get_v1_user_groups_canmanage",
"groups_get_v1_groups__groupId__community_feature_freezes",
"groups_post_v1_groups__groupId__community_tier_evaluate",
"groups_get_v1_groups__groupId__features",
"groups_patch_v1_groups__groupId__features",
"thumbnails_get_v1_groups_icons",
"develop_get_v1_groups__groupId__universes",
"develop_get_v1_user_groups_canmanagegamesoritems"
]
}
},
{
"name": "Interactions",
"description": "Manage your favorites, experience notifications, and assets you voted on. [List experiences opted-in for notifications for a user](#get_legacy_followings_v1_users__userId__universes), [manage favorites](#catalog_get_v1_favorites_users__userId__assets__assetId__favorite) for assets and bundles, and [track](#games_get_v1_games_votes) votes on experiences.\n",
"x-roblox-tag-info": {
"path": "interactions",
"content": "HTTP APIs for working with favorites, experience notifications, and other player interactions on Roblox Cloud.",
"ordering": [
"get_legacy_followings_v1_users__userId__universes",
"followings_get_v1_users__userId__universes",
"delete_legacy_followings_v1_users__userId__universes__universeId_",
"followings_delete_v1_users__userId__universes__universeId_",
"post_legacy_followings_v1_users__userId__universes__universeId_",
"followings_post_v1_users__userId__universes__universeId_",
"get_legacy_followings_v1_users__userId__universes__universeId__status",
"followings_get_v1_users__userId__universes__universeId__status",
"get_legacy_followings_v2_users__userId__universes",
"followings_get_v2_users__userId__universes",
"catalog_get_v1_favorites_assets__assetId__count",
"catalog_get_v1_favorites_bundles__bundleId__count",
"catalog_get_v1_favorites_users__userId__favorites__assetTypeId__assets",
"catalog_get_v1_users__userId__bundles__bundleType_",
"games_get_v1_games__universeId__favorites",
"games_post_v1_games__universeId__favorites",
"games_get_v1_games__universeId__favorites_count",
"Voting_VoteGame",
"Voting_GetGameVoteStatus",
"Voting_GetGameVoteStatusForUser",
"Voting_MultiGetGameVoteStatus",
"games_get_v2_users__userId__favorite_games",
"inventory_get_v1_users__userId__categories_favorites"
]
}
},
{
"name": "Inventories",
"description": "Access user inventories to verify ownership and display player collections. For detailed implementation details, see the [Inventory guide](/cloud/guides/inventory).\n\nYou can [retrieve and check](#Cloud_ListInventoryItems) if a user owns specific items, like limiteds, badges, passes, or private servers.\n",
"x-roblox-tag-info": {
"path": "inventories",
"content": "HTTP APIs for working with inventories on Roblox Cloud.",
"ordering": [
"Cloud_ListInventoryItems",
"inventory_delete_v1_collections_items__itemType___itemTargetId_",
"inventory_post_v1_collections_items__itemType___itemTargetId_",
"inventory_get_v1_packages__packageId__assets",
"inventory_get_v1_users__userId__assets_collectibles",
"inventory_get_v1_users__userId__can_view_inventory",
"inventory_get_v1_users__userId__categories",
"inventory_get_v1_users__userId__categories_favorites",
"inventory_get_v1_users__userId__items__itemType___itemTargetId_",
"inventory_get_v1_users__userId__items__itemType___itemTargetId__is_owned",
"inventory_get_v1_users__userId__places_inventory",
"inventory_get_v2_assets__assetId__owners",
"inventory_get_v2_collectible_items__collectibleItemId__owners",
"inventory_delete_v2_inventory_asset__assetId_",
"inventory_get_v2_users__userId__inventory",
"inventory_get_v2_users__userId__inventory__assetTypeId_"
]
}
},
{
"name": "Localization",
"description": "Extend [built-in Roblox localization features](production/localization) with automation.\n\nCommon use cases include:\n\n- Content translation: Update localized names and descriptions for [badges](#patch_legacy_game_internationalization_v1_badges__badgeId__description_language_codes__languageCode_), [game passes](#patch_legacy_game_internationalization_v1_game_passes__gamePassId__description_language_codes__languageCode_), and [developer products](#patch_legacy_game_internationalization_v1_developer_products__developerProductId__description_language_codes__languageCode_)\n- Localization tables: [Manage localization table entries](#patch_legacy_localization_tables_v1_localization_table_tables__tableId_) and [retrieve localized asset entries](#localizationtables_get_v1_localization_table_tables__tableId__asset_entries) for in-game text\n- Automatic translation: [Configure automatic translation settings](#patch_legacy_localization_tables_v1_autolocalization_games__gameId__settings) for supported languages\n",
"x-roblox-tag-info": {
"path": "localization",
"content": "HTTP APIs for localization on Roblox Cloud.",
"ordering": [
"patch_legacy_game_internationalization_v1_badges__badgeId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_badges__badgeId__icons",
"gameinternationalization_get_v1_badges__badgeId__icons",
"delete_legacy_game_internationalization_v1_badges__badgeId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_badges__badgeId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_badges__badgeId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_badges__badgeId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_badges__badgeId__name_description",
"gameinternationalization_get_v1_badges__badgeId__name_description",
"delete_legacy_game_internationalization_v1_badges__badgeId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_badges__badgeId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_badges__badgeId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_badges__badgeId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_badges__badgeId__name_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_developer_products__developerProductId__icons",
"gameinternationalization_get_v1_developer_products__developerProductId__icons",
"delete_legacy_game_internationalization_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_developer_products__developerProductId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_developer_products__developerProductId__name_description",
"gameinternationalization_get_v1_developer_products__developerProductId__name_description",
"delete_legacy_game_internationalization_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_developer_products__developerProductId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_developer_products__developerProductId__name_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_game_icon_games__gameId_",
"gameinternationalization_get_v1_game_icon_games__gameId_",
"delete_legacy_game_internationalization_v1_game_icon_games__gameId__language_codes__languageCode_",
"gameinternationalization_delete_v1_game_icon_games__gameId__language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_icon_games__gameId__language_codes__languageCode_",
"gameinternationalization_post_v1_game_icon_games__gameId__language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__description_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__description_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_game_passes__gamePassId__icons",
"gameinternationalization_get_v1_game_passes__gamePassId__icons",
"delete_legacy_game_internationalization_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"gameinternationalization_delete_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"gameinternationalization_post_v1_game_passes__gamePassId__icons_language_codes__languageCode_",
"get_legacy_game_internationalization_v1_game_passes__gamePassId__name_description",
"gameinternationalization_get_v1_game_passes__gamePassId__name_description",
"delete_legacy_game_internationalization_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"gameinternationalization_delete_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__name_description_language_codes__languageCode_",
"patch_legacy_game_internationalization_v1_game_passes__gamePassId__name_language_codes__languageCode_",
"gameinternationalization_patch_v1_game_passes__gamePassId__name_language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"delete_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"gameinternationalization_delete_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"patch_legacy_game_internationalization_v1_name_description_games__gameId_",
"gameinternationalization_patch_v1_name_description_games__gameId_",
"post_legacy_game_internationalization_v1_name_description_games_translation_history",
"gameinternationalization_post_v1_name_description_games_translation_history",
"patch_legacy_game_internationalization_v1_source_language_games__gameId_",
"gameinternationalization_patch_v1_source_language_games__gameId_",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId_",
"gameinternationalization_patch_v1_supported_languages_games__gameId_",
"get_legacy_game_internationalization_v1_supported_languages_games__gameId__automatic_translation_status",
"gameinternationalization_get_v1_supported_languages_games__gameId__automatic_translation_status",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status",
"gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__image_translation_status",
"gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__image_translation_status",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__universe_display_info_automatic_translation_settings",
"gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__universe_display_info_automatic_translation_settings",
"get_legacy_game_internationalization_v1_supported_languages_games__gameId__universe_display_info_automatic_translation_settings",
"gameinternationalization_get_v1_supported_languages_games__gameId__universe_display_info_automatic_translation_settings",
"post_legacy_localization_tables_v1_autolocalization_games__gameId__autolocalizationtable",
"localizationtables_post_v1_autolocalization_games__gameId__autolocalizationtable",
"patch_legacy_localization_tables_v1_autolocalization_games__gameId__settings",
"localizationtables_patch_v1_autolocalization_games__gameId__settings",
"get_legacy_localization_tables_v1_autolocalization_metadata",
"localizationtables_get_v1_autolocalization_metadata",
"get_legacy_localization_tables_v1_localization_table_limits",
"localizationtables_get_v1_localization_table_limits",
"localizationtables_patch_v1_autolocalization_games__gameId__autolocalizationtable",
"get_legacy_localization_tables_v1_localization_table_tables__assetId_",
"localizationtables_get_v1_localization_table_tables__assetId_",
"get_legacy_localization_tables_v1_localization_table_tables__tableId_",
"localizationtables_get_v1_localization_table_tables__tableId_",
"patch_legacy_localization_tables_v1_localization_table_tables__tableId_",
"localizationtables_patch_v1_localization_table_tables__tableId_",
"get_legacy_localization_tables_v1_localization_table_tables__tableId__entries",
"localizationtables_get_v1_localization_table_tables__tableId__entries",
"localizationtables_get_v1_localization_table_tables__tableId__asset_entries",
"post_legacy_localization_tables_v1_localization_table_tables__tableId__entries_translation_history",
"localizationtables_post_v1_localization_table_tables__tableId__entries_translation_history",
"get_legacy_localization_tables_v1_localization_table_tables__tableId__entry_count",
"localizationtables_get_v1_localization_table_tables__tableId__entry_count",
"economy_get_v1_user_currency",
"gameinternationalization_get_v1_automatic_translation_games__gameId__feature_status",
"gameinternationalization_get_v1_automatic_translation_games__gameId__quota",
"gameinternationalization_get_v1_automatic_translation_languages__languageCode__target_languages",
"gameinternationalization_get_v1_game_localization_status__gameId__translation_counts",
"gameinternationalization_get_v1_game_localization_status_translation_counts_for_language_or_locale",
"gameinternationalization_get_v1_game_thumbnails_games__gameId__images",
"gameinternationalization_get_v1_name_description_games__gameId_",
"gameinternationalization_get_v1_name_description_metadata",
"gameinternationalization_get_v1_source_language_games__gameId_",
"gameinternationalization_get_v1_supported_languages_games__gameId_",
"gameinternationalization_get_v1_supported_languages_metadata",
"gameinternationalization_get_v1_translation_analytics_games__gameId__download_translation_analytics_report",
"gameinternationalization_post_v1_translation_analytics_games__gameId__request_translation_analytics_report",
"gameinternationalization_get_v1_translation_analytics_metadata",
"gameinternationalization_get_v1_ui_configurations",
"gameinternationalization_get_v1_user_localization_settings_player_choice__universeId_",
"gameinternationalization_get_v1_user_localization_settings_universe__universeId_",
"gameinternationalization_post_v1_user_localization_settings_universe__universeId_",
"gameinternationalization_get_v1_source_language_games__gameId__language_with_locales",
"gameinternationalization_get_v1_supported_languages_games__gameId__in_experience_language_selection",
"locale_get_v1_country_regions",
"locale_get_v1_locales",
"locale_post_v1_locales_set_show_roblox_translations",
"locale_post_v1_locales_set_user_supported_locale",
"locale_get_v1_locales_supported_locales",
"locale_get_v1_locales_supported_locales_for_creators",
"locale_get_v1_locales_user_locale",
"locale_get_v1_locales_user_localization_locus_supported_locales",
"localizationtables_post_v1_auto_localization_table_games__gameId__assets_generation_request",
"localizationtables_post_v1_auto_localization_table_games__gameId__auto_scrape_cleanup_request",
"localizationtables_get_v1_localization_table_metadata",
"localizationtables_post_v1_localization_table_tables",
"localizationtables_post_v1_localization_table_tables__tableId__entries_translation_feedback",
"translationroles_patch_v1_game_localization_roles_games__gameId_",
"translationroles_get_v1_game_localization_roles_games__gameId__current_user_roles",
"translationroles_get_v1_game_localization_roles_games__gameId__roles__role__assignees",
"translationroles_get_v1_game_localization_roles_roles__role__current_user"
]
}
},
{
"name": "Luau Execution",
"description": "Run Luau scripts headlessly in a Roblox place via Open Cloud for automated testing, game configuration, and procedural generation, with full DataModel and engine Luau API access. Tasks can run for up to 5 minutes, with a limit of 10 concurrent tasks per place. You can save changes using [`SavePlaceAsync`](/reference/engine/classes/AssetService#SavePlaceAsync), pass in large binary payloads, and use [`SerializationService`](/reference/engine/classes/SerializationService) to deserialize RBXM content. For a reference implementation, see [Roblox/place-ci-cd-demo](https://github.com/Roblox/place-ci-cd-demo) on GitHub.\n\nWorkflow:\n\n1. [Create a task](#Cloud_CreateLuauExecutionSessionTask__Using_Universes) with your universeId, placeId, and the Luau script to run\n2. A server launches, loads the place, and executes your code\n3. [Poll for completion](#Cloud_GetLuauExecutionSessionTask) and receive the script's return values and [logs](#Cloud_ListLuauExecutionSessionTaskLogs)\n\nCommon use cases include:\n\n- Automated testing: Run test scripts against specific place versions as part of a CI/CD pipeline\n- Game configuration: Update pricing, stats, and balancing variables outside of Studio\n",
"x-roblox-tag-info": {
"path": "luau-execution",
"content": "HTTP APIs for Luau execution on Roblox Cloud.",
"ordering": [
"Cloud_CreateLuauExecutionSessionTaskBinaryInput",
"Cloud_CreateLuauExecutionSessionTask__Using_Universes",
"Cloud_CreateLuauExecutionSessionTask__Using_Universes_Places",
"Cloud_GetLuauExecutionSessionTask",
"Cloud_ListLuauExecutionSessionTaskLogs"
]
}
},
{
"name": "Matchmaking",
"description": "Configure and manage matchmaking for your experiences. Matchmaking APIs help you create fair, balanced matches by considering player skill, preferences, and latency.\n\nCommon use cases include:\n\n- Player attributes: [Define](#post_matchmaking_api_v1_matchmaking_player_attribute) and [manage](#patch_matchmaking_api_v1_matchmaking_player_attribute__attributeId_) custom player attributes for matching (skill level, preferences, etc.)\n- Scoring configuration: [Create](#post_matchmaking_api_v1_matchmaking_scoring_configuration) and [tune](#patch_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId_) scoring configurations that determine match quality\n- Instance control: [Shut down game instances](#post_matchmaking_api_v1_game_instances_shutdown) for maintenance\n",
"x-roblox-tag-info": {
"path": "matchmaking",
"content": "HTTP APIs for matchmaking on Roblox Cloud.",
"ordering": [
"post_matchmaking_api_v1_client_status",
"get_matchmaking_api_v1_client_status",
"post_matchmaking_api_v1_game_instances_shutdown",
"post_matchmaking_api_v1_game_instances_shutdown_all",
"post_matchmaking_api_v1_matchmaking_player_attribute",
"patch_matchmaking_api_v1_matchmaking_player_attribute__attributeId_",
"delete_matchmaking_api_v1_matchmaking_player_attribute__attributeId_",
"get_matchmaking_api_v1_matchmaking_player_attributes__universeId_",
"post_matchmaking_api_v1_matchmaking_server_attribute",
"patch_matchmaking_api_v1_matchmaking_server_attribute__attributeId_",
"delete_matchmaking_api_v1_matchmaking_server_attribute__attributeId_",
"get_matchmaking_api_v1_matchmaking_server_attributes__universeId_",
"get_matchmaking_api_v1_matchmaking_universe__universeId__feature_flags",
"post_matchmaking_api_v1_matchmaking_scoring_configuration",
"get_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId_",
"patch_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId_",
"delete_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId_",
"post_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId__signals",
"patch_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId__signals__signalName_",
"delete_matchmaking_api_v1_matchmaking_scoring_configuration__scoringConfigurationId__signals__signalName_",
"post_matchmaking_api_v1_matchmaking_scoring_configuration_place",
"delete_matchmaking_api_v1_matchmaking_scoring_configuration_place__placeId_",
"get_matchmaking_api_v1_matchmaking_scoring_configurations__universeId_",
"get_matchmaking_api_v1_matchmaking_scoring_configurations__universeId__places",
"get_matchmaking_api_v1_matchmaking_scoring_configuration_default_weights",
"post_matchmaking_api_v1_game_instances_forecast_update",
"post_matchmaking_api_v1_game_instances_launch_update",
"get_matchmaking_api_v1_game_instances_get_update_status",
"get_matchmaking_api_v1_matchmaking_scoring_configuration_generate_mock_servers"
]
}
},
{
"name": "Metadata",
"description": "Retrieve configuration metadata and system information from various Roblox services, including settings, quotas, and limits.\n",
"x-roblox-tag-info": {
"path": "metadata",
"content": "HTTP APIs for working with metadata on Roblox Cloud.",
"ordering": [
"get_legacy_localization_tables_v1_autolocalization_metadata",
"localizationtables_get_v1_autolocalization_metadata",
"get_legacy_localization_tables_v1_localization_table_limits",
"localizationtables_get_v1_localization_table_limits",
"accountinformation_get_v1_metadata",
"auth_get_v1_auth_metadata",
"auth_get_v1_metadata",
"auth_get_v1_recovery_metadata",
"auth_get_v2_auth_metadata",
"auth_get_v2_metadata",
"auth_get_v2_passwords_reset",
"auth_get_v2_recovery_metadata",
"avatar_get_v1_avatar_metadata",
"badges_get_v1_badges_metadata",
"clientsettings_get_v1_client_version__binaryType_",
"clientsettings_get_v1_installer_cdns",
"clientsettings_get_v1_mobile_client_version",
"clientsettings_get_v2_android_binaries__version__channels__channelName_",
"clientsettings_get_v2_client_version__binaryType_",
"clientsettings_get_v2_client_version__binaryType__channel__channelName_",
"clientsettings_get_v2_compression_dictionaries",
"clientsettings_get_v2_compression_dictionaries__dictionarySha256_",
"clientsettings_get_v2_ota_version__binaryType_",
"clientsettings_get_v2_user_channel",
"gameinternationalization_get_v1_name_description_metadata",
"gameinternationalization_get_v1_supported_languages_metadata",
"gameinternationalization_get_v1_translation_analytics_metadata",
"gameinternationalization_get_v1_ui_configurations",
"locale_post_v1_locales_set_user_supported_locale",
"locale_get_v1_locales_supported_locales",
"locale_get_v1_locales_supported_locales_for_creators",
"locale_get_v1_locales_user_localization_locus_supported_locales",
"localizationtables_get_v1_localization_table_metadata",
"notifications_get_v2_push_notifications_chrome_manifest",
"notifications_get_v2_push_notifications_get_current_device_destination",
"notifications_get_v2_push_notifications_metadata",
"notifications_get_v2_stream_notifications_metadata",
"twostepverification_get_v1_metadata"
]
}
},
{
"name": "Notifications",
"description": "Send personalized notifications to re-engage players and keep them informed about your experience. Each user can receive one notification per day from a given experience. See the [Experience Notifications Guide](/cloud/guides/experience-notifications).\n\nCommon use cases include:\n\n- Experience notifications: [Send targeted notifications](#Cloud_CreateUserNotification) to users about in-game events, rewards, or updates\n- Personalized messages: Customize notifications with dynamic parameters like usernames and scores\n- **Launch Data Integration**: Include launch data to route users to specific locations when they join\n",
"x-roblox-tag-info": {
"path": "notifications",
"content": "HTTP APIs for working with notifications on Roblox Cloud.",
"ordering": [
"Cloud_CreateUserNotification",
"notifications_get_v2_push_notifications_chrome_manifest",
"notifications_post_v2_push_notifications_deregister_all_devices",
"notifications_post_v2_push_notifications_deregister_current_device",
"notifications_post_v2_push_notifications_deregister_current_device_ios_pushkit",
"notifications_get_v2_push_notifications_get_current_device_destination",
"notifications_get_v2_push_notifications_get_destinations",
"notifications_get_v2_push_notifications_metadata",
"notifications_post_v2_push_notifications_register_android_native",
"notifications_post_v2_push_notifications_register_ios_native",
"notifications_post_v2_push_notifications_register_ios_pushkit",
"notifications_post_v2_stream_notifications_clear_unread",
"notifications_get_v2_stream_notifications_get_latest_game_updates",
"notifications_get_v2_stream_notifications_get_recent",
"notifications_get_v2_stream_notifications_metadata",
"notifications_get_v2_stream_notifications_unread_count"
]
}
},
{
"name": "Observability",
"description": "Monitor and manage game servers for an experience.\n\nCommon use cases include:\n\n- Server discovery: [List active game servers](#GameServers_ListGameServers) for a specific place version and [retrieve available filter options](#GameServers_GetFilterOptions)\n- Log retrieval: [Inspect logs](#GameServers_ListGameServerLogs) for a specific game server\n- Server restarts: [Forecast the impact](#Restarts_ForecastRestart) of a restart, [launch it](#Restarts_LaunchRestart), and [monitor its status](#Restarts_ListRestartStatuses)\n",
"x-roblox-tag-info": {
"path": "observability",
"content": "HTTP APIs for monitoring and managing game servers on Roblox Cloud.",
"ordering": [
"GameServers_GetFilterOptions",
"GameServers_ListGameServers",
"GameServers_ListGameServerLogs",
"Restarts_ForecastRestart",
"Restarts_ListRestartStatuses",
"Restarts_LaunchRestart"
]
}
},
{
"name": "Places",
"description": "Manage places, update instance properties, and publish place versions programmatically. See the [Engine Instances Guide](/cloud/guides/instance) and [Place Publishing Guide](/cloud/guides/usage-place-publishing).\n\nCommon use cases include:\n\n- Automated publishing: Publish place updates from CI/CD pipelines with version control and rollback support\n- Instance management: [Read](#Cloud_GetInstance) and [update](#Cloud_UpdateInstance) Script, LocalScript, and ModuleScript objects in collaborative sessions\n- Luau execution: [Run Luau scripts](#Cloud_CreateLuauExecutionSessionTask__Using_Universes) on specific place versions for testing or automation\n",
"x-roblox-tag-info": {
"path": "places",
"content": "HTTP APIs for working with places on Roblox Cloud.",
"ordering": [
"Cloud_GetPlace",
"Cloud_UpdatePlace",
"Cloud_GetInstance",
"Cloud_UpdateInstance",
"Cloud_GetUpdateInstanceOperation",
"Cloud_ListInstanceChildren",
"Cloud_CreateLuauExecutionSessionTask__Using_Universes",
"Cloud_ListUserRestrictions__Using_Universes",
"Cloud_GetUserRestriction__Using_Universes_Places",
"Cloud_UpdateUserRestriction__Using_Universes_Places",
"Cloud_CreateLuauExecutionSessionTask__Using_Universes_Places",
"Cloud_GetLuauExecutionSessionTask",
"Cloud_ListLuauExecutionSessionTaskLogs",
"PlaceVersion_GetPlaceVersionHistory",
"PlaceVersion_UpdatePlaceVersionNotes",
"PlaceVersion_GetPlaceContributors",
"get_legacy_develop_v1_places__placeId__teamcreate_active_session_members",
"develop_get_v1_places__placeId__teamcreate_active_session_members",
"delete_legacy_develop_v2_teamtest__placeId_",
"develop_delete_v2_teamtest__placeId_",
"Places_CreatePlaceVersionApiKey",
"develop_patch_v1_places__placeId_",
"develop_post_v1_places__placeId_",
"develop_get_v1_universes__universeId__places",
"develop_get_v2_places__placeId_",
"develop_patch_v2_places__placeId_",
"games_get_v1_games_multiget_place_details",
"inventory_get_v1_users__userId__places_inventory"
]
}
},
{
"name": "Private servers",
"description": "Create and manage private servers for your experiences, including server creation, access control, and subscription management.\n",
"x-roblox-tag-info": {
"path": "private-servers",
"content": "HTTP APIs for working with private servers on Roblox Cloud.",
"ordering": [
"develop_get_v1_universes__universeId__configuration_vip_servers",
"PrivateServers_GetPrivateServerList"
]
}
},
{
"name": "Team Create",
"description": "Manage Team Create collaborative sessions for your experiences, including session monitoring, membership management, and collaboration settings.\n",
"x-roblox-tag-info": {
"path": "team-create",
"content": "HTTP APIs for working with Team Create on Roblox Cloud.",
"ordering": [
"get_legacy_develop_v1_places__placeId__teamcreate_active_session_members",
"develop_get_v1_places__placeId__teamcreate_active_session_members",
"get_legacy_develop_v1_universes__universeId__teamcreate",
"develop_get_v1_universes__universeId__teamcreate",
"patch_legacy_develop_v1_universes__universeId__teamcreate",
"develop_patch_v1_universes__universeId__teamcreate",
"delete_legacy_develop_v1_universes__universeId__teamcreate_memberships",
"develop_delete_v1_universes__universeId__teamcreate_memberships",
"get_legacy_develop_v1_universes_multiget_teamcreate",
"develop_get_v1_universes_multiget_teamcreate",
"delete_legacy_develop_v2_teamtest__placeId_",
"develop_delete_v2_teamtest__placeId_"
]
}
},
{
"name": "Thumbnail Personalization",
"description": "Upload and manage creator-provided homepage thumbnail variants for an experience, then choose which player groups see each variant. Unlike the Thumbnails feature, these APIs manage homepage images and targeting rules instead of generating or retrieving standard Roblox thumbnails.\n",
"x-roblox-tag-info": {
"path": "thumbnail-personalization",
"content": "HTTP APIs for working with homepage thumbnail personalization on Roblox Cloud.",
"ordering": [
"ThumbnailPersonalizationApi.HomepageThumbnail_UploadHomepageThumbnails",
"ThumbnailPersonalizationApi.HomepageThumbnail_GetHomepageThumbnailsStatus",
"ThumbnailPersonalizationApi.HomepageThumbnail_GetHomepageThumbnails",
"ThumbnailPersonalizationApi.HomepageThumbnail_DeleteHomepageThumbnails",
"ThumbnailPersonalizationApi.HomepageThumbnail_CreateThumbnailPersonalization",
"ThumbnailPersonalizationApi.HomepageThumbnail_FindThumbnailPersonalizations",
"ThumbnailPersonalizationApi.HomepageThumbnail_UpdateThumbnailPersonalization"
]
}
},
{
"name": "Thumbnails",
"description": "Generate and retrieve thumbnails for [users](#Cloud_GenerateUserThumbnail), [experiences](#post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__image), [badges](#post_legacy_publish_v1_badges__badgeId__icon), and [avatar images](#Cloud_GenerateUserThumbnail) in various formats. [Retrieve thumbnail-generation status](#Cloud_GetUserThumbnailGenerationOperation) as part of the user thumbnail workflow.\n",
"x-roblox-tag-info": {
"path": "thumbnails",
"content": "HTTP APIs for working with user thumbnails on Roblox Cloud.",
"ordering": [
"Cloud_GenerateUserThumbnail",
"Cloud_GetUserThumbnailGenerationOperation",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"delete_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"gameinternationalization_delete_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"post_legacy_publish_v1_badges__badgeId__icon",
"publish_post_v1_badges__badgeId__icon",
"avatar_post_v1_avatar_redraw_thumbnail",
"games_get_v2_games__universeId__media",
"thumbnails_get_v1_asset_thumbnail_animated",
"thumbnails_get_v1_assets",
"thumbnails_get_v1_assets_thumbnail_3d",
"thumbnails_get_v1_badges_icons",
"thumbnails_post_v1_batch",
"thumbnails_get_v1_bundles_thumbnails",
"thumbnails_get_v1_developer_products_icons",
"thumbnails_get_v1_game_passes",
"thumbnails_get_v1_games__universeId__thumbnails",
"thumbnails_get_v1_games_icons",
"thumbnails_get_v1_games_multiget_thumbnails",
"thumbnails_get_v1_groups_icons",
"thumbnails_get_v1_places_gameicons",
"thumbnails_get_v1_users_avatar",
"thumbnails_get_v1_users_avatar_3d",
"thumbnails_get_v1_users_avatar_bust",
"thumbnails_get_v1_users_avatar_headshot",
"thumbnails_get_v1_users_outfit_3d",
"thumbnails_get_v1_users_outfits",
"thumbnailsresizer_get_v1_resize__hash___width___height___type___format___filterType_",
"thumbnailsresizer_get_v1_secureresize__thumbPrint___hash___width___height___type___format___filterType_"
]
}
},
{
"name": "Trades",
"description": "Manage item trades between users on the Roblox platform. [Check trade eligibility](#trades_get_v2_users__userId__can_trade_with) between users, [retrieve trade details](#trades_get_v2_trades__tradeId_), and [list trades by status](#trades_get_v1_trades__tradeStatusType_) (pending, completed, declined, expired).\n",
"x-roblox-tag-info": {
"path": "trades",
"content": "HTTP APIs for working with trades on Roblox Cloud.",
"ordering": [
"trades_get_v2_users__userId__can_trade_with",
"trades_get_v2_users_me_can_trade",
"trades_get_v1_users__userId__can_trade_with",
"trades_get_v2_trades__tradeId_",
"trades_get_v1_trades__tradeId_",
"trades_post_v2_trades_send",
"trades_post_v1_trades_send",
"trades_post_v1_trades__tradeId__accept",
"trades_post_v2_trades__tradeId__counter",
"trades_post_v1_trades__tradeId__counter",
"trades_post_v1_trades__tradeId__decline",
"trades_get_v1_trades__tradeStatusType_",
"trades_get_v1_trades__tradeStatusType__count",
"trades_post_v1_trades_expire_outdated",
"trades_get_v1_trades_metadata",
"trades_get_v2_users__userId__tradableItems"
]
}
},
{
"name": "Universes",
"description": "Manage experiences (universes), publish updates, and communicate with live servers. See the [Messaging Usage Guide](/cloud/guides/usage-messaging) and [Place Publishing Guide](/cloud/guides/usage-place-publishing).\n\nCommon use cases include:\n\n- **Cross-Server Messaging**: [Send announcements](#Cloud_PublishUniverseMessage), trigger events, or update all players across servers using the Messaging Service\n- User restrictions: [Ban or restrict users](#Cloud_UpdateUserRestriction__Using_Universes) from your experience at the universe or place level\n- Playtester access: [List](#develop_get_v1_universes__universeId__configuration_playtesters), [add](#develop_post_v1_universes__universeId__configuration_playtesters), or [remove](#develop_delete_v1_universes__universeId__configuration_playtesters) playtesters for a universe\n",
"x-roblox-tag-info": {
"path": "universes",
"content": "HTTP APIs for working with universes on Roblox Cloud, including subscriptions, place and instance updates, user restrictions, and more.",
"ordering": [
"Cloud_GetUniverse",
"Cloud_UpdateUniverse",
"Cloud_PublishUniverseMessage",
"Cloud_RestartUniverseServers",
"Cloud_GetPlace",
"Cloud_UpdatePlace",
"Cloud_GetInstance",
"Cloud_UpdateInstance",
"Cloud_ListInstanceChildren",
"Cloud_ListUserRestrictions__Using_Universes",
"Cloud_GetUserRestriction__Using_Universes_Places",
"Cloud_UpdateUserRestriction__Using_Universes_Places",
"Cloud_ListUserRestrictions",
"Cloud_ListUserRestrictionLogs",
"Cloud_GetUserRestriction__Using_Universes",
"Cloud_UpdateUserRestriction__Using_Universes",
"post_legacy_badges_v1_universes__universeId__badges",
"badges_post_v1_universes__universeId__badges",
"get_legacy_develop_v1_places__placeId__teamcreate_active_session_members",
"develop_get_v1_places__placeId__teamcreate_active_session_members",
"post_legacy_develop_v1_universes__universeId__activate",
"develop_post_v1_universes__universeId__activate",
"post_legacy_develop_v1_universes__universeId__deactivate",
"develop_post_v1_universes__universeId__deactivate",
"get_legacy_develop_v1_universes__universeId__permissions",
"develop_get_v1_universes__universeId__permissions",
"develop_get_v1_universes__universeId__configuration_playtesters",
"develop_post_v1_universes__universeId__configuration_playtesters",
"develop_delete_v1_universes__universeId__configuration_playtesters",
"get_legacy_develop_v1_universes__universeId__teamcreate",
"develop_get_v1_universes__universeId__teamcreate",
"patch_legacy_develop_v1_universes__universeId__teamcreate",
"develop_patch_v1_universes__universeId__teamcreate",
"delete_legacy_develop_v1_universes__universeId__teamcreate_memberships",
"develop_delete_v1_universes__universeId__teamcreate_memberships",
"get_legacy_develop_v1_universes_multiget_permissions",
"develop_get_v1_universes_multiget_permissions",
"get_legacy_develop_v1_universes_multiget_teamcreate",
"develop_get_v1_universes_multiget_teamcreate",
"get_legacy_followings_v1_users__userId__universes",
"followings_get_v1_users__userId__universes",
"delete_legacy_followings_v1_users__userId__universes__universeId_",
"followings_delete_v1_users__userId__universes__universeId_",
"post_legacy_followings_v1_users__userId__universes__universeId_",
"followings_post_v1_users__userId__universes__universeId_",
"get_legacy_followings_v1_users__userId__universes__universeId__status",
"followings_get_v1_users__userId__universes__universeId__status",
"get_legacy_followings_v2_users__userId__universes",
"followings_get_v2_users__userId__universes",
"get_legacy_game_internationalization_v1_game_icon_games__gameId_",
"gameinternationalization_get_v1_game_icon_games__gameId_",
"delete_legacy_game_internationalization_v1_game_icon_games__gameId__language_codes__languageCode_",
"gameinternationalization_delete_v1_game_icon_games__gameId__language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_icon_games__gameId__language_codes__languageCode_",
"gameinternationalization_post_v1_game_icon_games__gameId__language_codes__languageCode_",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__alt_text",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__image",
"delete_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"gameinternationalization_delete_v1_game_thumbnails_games__gameId__language_codes__languageCode__images__imageId_",
"post_legacy_game_internationalization_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"gameinternationalization_post_v1_game_thumbnails_games__gameId__language_codes__languageCode__images_order",
"patch_legacy_game_internationalization_v1_name_description_games__gameId_",
"gameinternationalization_patch_v1_name_description_games__gameId_",
"post_legacy_game_internationalization_v1_name_description_games_translation_history",
"gameinternationalization_post_v1_name_description_games_translation_history",
"patch_legacy_game_internationalization_v1_source_language_games__gameId_",
"gameinternationalization_patch_v1_source_language_games__gameId_",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId_",
"gameinternationalization_patch_v1_supported_languages_games__gameId_",
"get_legacy_game_internationalization_v1_supported_languages_games__gameId__automatic_translation_status",
"gameinternationalization_get_v1_supported_languages_games__gameId__automatic_translation_status",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status",
"gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status",
"patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__universe_display_info_automatic_translation_settings",
"gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__universe_display_info_automatic_translation_settings",
"get_legacy_game_internationalization_v1_supported_languages_games__gameId__universe_display_info_automatic_translation_settings",
"gameinternationalization_get_v1_supported_languages_games__gameId__universe_display_info_automatic_translation_settings",
"post_legacy_localization_tables_v1_autolocalization_games__gameId__autolocalizationtable",
"localizationtables_post_v1_autolocalization_games__gameId__autolocalizationtable",
"patch_legacy_localization_tables_v1_autolocalization_games__gameId__settings",
"localizationtables_patch_v1_autolocalization_games__gameId__settings",
"CrossServerMessaging_Publish",
"Places_CreatePlaceVersionApiKey",
"get_cloud_v2_universes__universeId__secrets_public_key",
"get_cloud_v2_universes__universeId__secrets",
"post_cloud_v2_universes__universeId__secrets",
"patch_cloud_v2_universes__universeId__secrets__secretId_",
"delete_cloud_v2_universes__universeId__secrets__secretId_",
"avatar_get_v1_game_start_info",
"badges_get_v1_universes__universeId__badges",
"badges_get_v1_universes__universeId__free_badges_quota",
"develop_get_v1_gametemplates",
"develop_get_v1_groups__groupId__universes",
"develop_get_v1_universes__universeId_",
"develop_get_v1_universes__universeId__configuration",
"develop_patch_v1_universes__universeId__configuration",
"develop_get_v1_universes__universeId__places",
"develop_get_v1_universes_multiget",
"develop_get_v1_user_groups_canmanagegamesoritems",
"develop_get_v1_universes__universeId__activation_eligibility",
"develop_get_v1_universes_user_public_publish_eligibility",
"develop_get_v1_user_universes",
"develop_patch_v2_universes__universeId__configuration",
"economycreatorstats_get_v1_universes__universeId__stats",
"gameinternationalization_get_v1_automatic_translation_games__gameId__feature_status",
"gameinternationalization_get_v1_automatic_translation_games__gameId__quota",
"gameinternationalization_get_v1_game_localization_status__gameId__translation_counts",
"gameinternationalization_get_v1_game_localization_status_translation_counts_for_language_or_locale",
"gameinternationalization_get_v1_game_thumbnails_games__gameId__images",
"gameinternationalization_get_v1_name_description_games__gameId_",
"gameinternationalization_get_v1_source_language_games__gameId_",
"gameinternationalization_get_v1_supported_languages_games__gameId_",
"gameinternationalization_get_v1_translation_analytics_games__gameId__download_translation_analytics_report",
"gameinternationalization_post_v1_translation_analytics_games__gameId__request_translation_analytics_report",
"gameinternationalization_get_v1_user_localization_settings_universe__universeId_",
"gameinternationalization_post_v1_user_localization_settings_universe__universeId_",
"gameinternationalization_get_v2_supported_languages_games__gameId_",
"games_get_v1_games",
"games_get_v1_games__universeId__favorites",
"games_post_v1_games__universeId__favorites",
"games_get_v1_games__universeId__favorites_count",
"Voting_VoteGame",
"Voting_GetGameVoteStatus",
"Voting_GetGameVoteStatusForUser",
"games_get_v1_games_games_product_info",
"games_get_v1_games_multiget_place_details",
"games_get_v1_games_multiget_playability_status",
"games_get_v1_games_recommendations_game__universeId_",
"Voting_MultiGetGameVoteStatus",
"games_get_v2_games__universeId__media",
"games_get_v2_users__userId__favorite_games",
"games_get_v2_users__userId__games",
"inventory_get_v1_users__userId__places_inventory",
"localizationtables_post_v1_auto_localization_table_games__gameId__assets_generation_request",
"localizationtables_post_v1_auto_localization_table_games__gameId__auto_scrape_cleanup_request",
"notifications_get_v2_stream_notifications_get_latest_game_updates",
"thumbnails_get_v1_games__universeId__thumbnails",
"thumbnails_get_v1_games_icons",
"thumbnails_get_v1_games_multiget_thumbnails",
"thumbnails_get_v1_places_gameicons",
"translationroles_patch_v1_game_localization_roles_games__gameId_",
"translationroles_get_v1_game_localization_roles_games__gameId__current_user_roles",
"translationroles_get_v1_game_localization_roles_games__gameId__roles__role__assignees",
"translationroles_get_v1_game_localization_roles_roles__role__current_user"
]
}
},
{
"name": "User profiles",
"description": "Access user profile pages. [Retrieve user descriptions](#users_get_v1_description), [badges](#accountinformation_get_v1_users__userId__roblox_badges), [avatar configuration](#avatar_get_v1_users__userId__avatar), and [wearing items](#avatar_get_v1_users__userId__currently_wearing).\n",
"x-roblox-tag-info": {
"path": "user-profiles",
"content": "HTTP APIs for working with user profiles on Roblox Cloud.",
"ordering": [
"accountinformation_get_v1_description",
"accountinformation_post_v1_description",
"accountinformation_get_v1_metadata",
"accountinformation_get_v1_promotion_channels",
"accountinformation_get_v1_users__userId__promotion_channels",
"accountinformation_get_v1_users__userId__roblox_badges",
"avatar_post_v1_avatar_redraw_thumbnail",
"avatar_get_v4_avatar_users__userId_",
"avatar_get_v1_users__userId__avatar",
"avatar_get_v1_users__userId__currently_wearing",
"Presence_GetUserPresences",
"users_get_v1_users__userId_",
"users_patch_v1_users__userId__display_names",
"users_get_v1_users__userId__username_history",
"users_get_v1_description",
"users_post_v1_description"
]
}
},
{
"name": "Users",
"description": "Retrieve user information, manage inventories, and restrict users from your experience. See the [Inventory Guide](/cloud/guides/inventory) for code examples.\n\nCommon use cases include:\n\n- User lookup: [Search users by username](#users_get_v1_users_search) or ID and [retrieve profile information](#Cloud_GetUser)\n- Avatar thumbnails: [Generate a user thumbnail](#Cloud_GenerateUserThumbnail) and [retrieve its generation operation](#Cloud_GetUserThumbnailGenerationOperation)\n- Inventory access: [List user-owned items](#Cloud_ListInventoryItems), badges, and collectibles\n- User restrictions: [Manage experience-level bans](#Cloud_UpdateUserRestriction__Using_Universes) and access restrictions\n",
"x-roblox-tag-info": {
"path": "users",
"content": "HTTP APIs for working with users on Roblox Cloud, including inventory items, restrictions, subscriptions, and more.",
"ordering": [
"users_get_v1_users_search",
"users_post_v1_usernames_users",
"users_post_v1_users",
"Cloud_GetUser",
"users_get_v1_users__userId_",
"Presence_GetUserPresences",
"accountinformation_get_v1_users__userId__promotion_channels",
"users_get_v1_display_names_validate",
"users_get_v1_users__userId__display_names_validate",
"users_get_v1_users__userId__username_history",
"users_patch_v1_users__userId__display_names",
"avatar_get_v1_users__userId__currently_wearing",
"avatar_get_v2_avatar_users__userId__avatar",
"avatar_get_v1_users__userId__avatar",
"avatar_get_v2_avatar_users__userId__outfits",
"avatar_get_v1_users__userId__outfits",
"Cloud_ListInventoryItems",
"inventory_get_v1_users__userId__can_view_inventory",
"inventory_get_v1_users__userId__assets_collectibles",
"inventory_get_v1_users__userId__items__itemType___itemTargetId__is_owned",
"inventory_get_v1_users__userId__items__itemType___itemTargetId_",
"inventory_get_v1_users__userId__places_inventory",
"inventory_get_v2_users__userId__inventory",
"inventory_get_v2_users__userId__inventory__assetTypeId_",
"inventory_get_v1_users__userId__categories",
"inventory_get_v1_users__userId__categories_favorites",
"accountinformation_get_v1_users__userId__roblox_badges",
"Cloud_ListAssetQuotas",
"Cloud_GenerateUserThumbnail",
"Cloud_GetUserThumbnailGenerationOperation",
"inventory_get_v2_assets__assetId__owners",
"inventory_get_v2_collectible_items__collectibleItemId__owners",
"catalog_get_v1_favorites_users__userId__favorites__assetTypeId__assets",
"catalog_get_v1_users__userId__bundles__bundleType_",
"friends_get_v1_users__userId__friends_statuses",
"contacts_post_v1_user_get_tags",
"contacts_get_v1_user_tag_validate",
"contacts_post_v1_user_tag",
"get_legacy_followings_v1_users__userId__universes",
"followings_get_v1_users__userId__universes",
"post_legacy_followings_v1_users__userId__universes__universeId_",
"followings_post_v1_users__userId__universes__universeId_",
"get_legacy_followings_v1_users__userId__universes__universeId__status",
"followings_get_v1_users__userId__universes__universeId__status",
"delete_legacy_followings_v1_users__userId__universes__universeId_",
"followings_delete_v1_users__userId__universes__universeId_",
"get_legacy_followings_v2_users__userId__universes",
"followings_get_v2_users__userId__universes",
"get_legacy_develop_v1_user_groups_canmanage",
"develop_get_v1_user_groups_canmanage",
"develop_get_v1_user_groups_canmanagegamesoritems",
"games_get_v2_users__userId__games",
"games_get_v2_users__userId__favorite_games",
"Cloud_ListUserRestrictions",
"Cloud_ListUserRestrictions__Using_Universes",
"Cloud_GetUserRestriction__Using_Universes",
"Cloud_GetUserRestriction__Using_Universes_Places",
"Cloud_UpdateUserRestriction__Using_Universes",
"Cloud_UpdateUserRestriction__Using_Universes_Places",
"Cloud_ListUserRestrictionLogs",
"Cloud_CreateUserNotification",
"Cloud_GetSubscription",
"translationroles_get_v1_game_localization_roles_games__gameId__roles__role__assignees"
]
}
}
]
}