/
RO
roblox
/
Roblox API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 7h ago · Updated 7h ago
Details
Filter operations
Accounts
173
get
Get metadata for adding auth methods.
get
Gets the account pin status.
post
Request to create the account pin.
delete
Request for deletes the account pin from the account.
patch
Request made to update the account pin on the account.
post
Request to locks the account which has an account pin enabled.
post
Requests to unlock the account pin.
get
Get a user's current account country setting.
post
Updates the user's account country.
get
Returns metadata used by the account settings page
get
Migrate from RobloxWebsite project, return news notification for Private Message page
get
get
Gets Auth meta data
get
Get the user's birthdate
post
Update the user's birthdate
get
Get the user's birthdate
get
Creates a client assertion to be used when generating an auth ticket.
get
Get the user's description
post
Update the user's description
get
Get the user's description
post
Update the user's description
get
Gets the authenticated user's email address and verified status
post
Updates the authenticated user's email address
patch
Updates the authenticated user's email address
post
Verify the user's email address from token
post
Send verify email to the authenticated user's email address
get
Gets the authenticated user's verified email and pending (unverified) email if one exists
post
Signs a user up for Roblox and links the account to the authenticated external provider ID.
post
Logs in a user to Roblox based on the user's authenticated external provider session
post
Deprecated endpoint Logins in a user to Roblox, then links the Roblox account to the external provider ID
post
Signs a user up for Roblox and links the account to the authenticated external provider ID
post
Unlink the logged in Roblox account from the current external provider ID
get
OAuth callback for identity providers that return the authorization code on a GET redirect (Okta, Google).
get
Signs a user up for Roblox and links the account to the authenticated external provider ID via OAuth.
get
Gets a list of universe playability statuses for the authenticated user
get
Get the user's gender
post
Update the user's gender
get
Get the user's gender
post
Update the user's gender
post
Endpoint for login with identity verification
post
Initiates identifier-first login flow by returning a list of login methods for user(s).
post
Authenticates a user.
post
Endpoint for logging in a user, specifically for linked authentication on PCGDK
post
Destroys the current authentication session.
post
Logs out user from all other sessions.
get
Gets a user's messages.
post
Archives a batch of messages.
post
Marks a batch of messages as read.
post
Marks a batch of messages as unread.
post
Unarchives a batch of messages.
get
Gets unread messages for the authenticated user.
get
Gets a message's details.
get
Get the metadata
get
Get the metadata
get
Gets two step verification system metadata.
post
Disables a batch of credentials for the specified user.
post
Complete Passkey registration by providing credential creation options.
post
List a user's registered passkeys.
post
Provides a challenge for the Passkey to authenticate.
post
Initiates Passkey registration by providing credential creation options.
post
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
Initializes passkey authentication for the user(s) corresponding to the identifier provided.
post
Initiates Passkey preauthenticated registration by providing credential creation options.
get
Checks whether the authenticated user is eligible for silent passkey upgrade. Route and response are intentionally obfuscated ("su-eligibility" = "silent-upgrade-eligibility").
get
Endpoint for checking if a password is valid.
post
Endpoint for checking if a password is valid.
get
Get Verified Phone Number
post
Set Phone Number
post
Delete Phone
post
Resend Phone code
post
Verify Phone
get
Get the user's promotion channels
post
Update the user's promotion channels
get
Get metadata for forgot endpoints
get
Get Revert Account ticket info
post
Submit Revert Account Request
post
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.
post
Logs out user from the current session and create a new one.
post
Endpoint for signing up a new user
post
Endpoint for signing up a new user, specifically for linked authentication on PCGDK
get
Get social network user information if the given social auth method is connected to current user.
post
Removes the given social authentication method from current Roblox user if it is connected.
get
returns all the enabled theme types.
get
returns the theme type for a specific consumer.
patch
Modify the theme type for consumer.
get
Get a user's trade privacy setting
post
Updates a user's trade privacy setting
get
Get a user's trade quality filter setting
post
Updates a user's trade quality filter setting
post
Changes the password for the authenticated user.
post
Change the user's username
get
Get the current price for a username change
get
Gets a list of existing usernames on Roblox based on the query parameters
post
Sends an email of all accounts belonging to an email
get
Checks if a username is valid.
post
Checks if a username is valid.
get
Gets the minimal authenticated user.
get
Gets the age bracket of the authenticated user.
get
Gets the country code of the authenticated user.
get
Gets the (public) roles of the authenticated user, such as `"Soothsayer"` and `"BetaTester"`.
get
Gets whether the specified user's inventory can be viewed.
post
Verifies a two step verification challenge code via authenticator app.
post
Reverts a user's dialog state from ACTIVE to PENDING.
post
Retry a Cross Device two step verification approval.
post
Verifies a two step verification approval via Cross Device. Cross Device approval does not use a verification code.
post
Sends a two step verification challenge code via email.
post
Verifies a two step verification challenge with a code sent via email.
post
Validates the assertion data returned by the passkey.
post
Provides a challenge for the passkey to authenticate.
post
Verifies a two step verification challenge with a password (code).
post
Verifies a two step verification challenge via a recovery code.
post
Validates the assertion data returned by the security key.
post
Provides a challenge for the security key to authenticate.
post
Sends a two step verification code via SMS for the specified user.
post
Verifies a two step verification challenge with a code sent via SMS.
get
Gets two step verification configuration for the specified user.
post
Disables two step verification via authenticator for the specified user.
post
Initiates enabling authenticator-based two step verification for the specified user.
post
Finishes enabling authenticator-based two step verification for the specified user.
post
Disables two step verification via email for the specified user.
post
Enables two step verification via email for the specified user.
post
Disables a batch of credentials for the specified user.
post
Initiates security key registration by providing credential creation options.
post
Finishes security key registration and stores credential. Enables security key as a 2sv media type if it is a user's first key.
post
List a user's registered security keys.
post
Disables two step verification via SMS for the specified user.
post
Enables two step verification via SMS for the specified user.
get
Get promotion channels for a given user ID
get
Gets the current status of recovery codes for a user.
post
Clears any existing recovery codes for the user.
post
Clears any existing recovery codes and generates a new batch of recovery codes.
get
Returns a list of Roblox badges belonging to a user.
get
Tries to check if an email is valid
get
Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.
post
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
Tries to get a valid username if the current username is taken
post
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
Check if the current user has an Xbox connected. Also returns the gamertag of the Xbox account if connected.
post
Unlink the current ROBLOX account from the Xbox live account.
get
Get the consecutive days the xbox user has been logged in.
post
Translate the xbox user to roblox user.
get
Gets Auth meta data
post
Endpoint for login with identity verification
post
Authenticates a user.
post
Endpoint for logging in a user, specifically for linked authentication on PCGDK
post
Destroys the current authentication session.
post
Logs out user from all other sessions.
get
Get the metadata
get
Returns password status for current user, asynchronously.
get
Gets metadata needed for the password reset view.
post
Resets a password for a user that belongs to the password reset ticket.
post
Sends a password reset email or challenge to the specified target.
post
Verifies a password reset challenge solution.
get
Endpoint for checking if a password is valid.
post
Endpoint for checking if a password is valid.
get
Gets valid destinations associated with the signed user
get
Get metadata for forgot endpoints
get
Get Revert Account ticket info
post
Submit Revert Account Request
post
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.
post
Logs out user from the current session and create a new one.
post
Endpoint for signing up a new user
post
Endpoint for signing up a new user, specifically for linked authentication on PCGDK
post
Changes the password for the authenticated user.
post
Change the user's username
get
Get the current price for a username change
get
Gets a list of existing usernames on Roblox based on the query parameters
post
Sends an email of all accounts belonging to an email
get
Checks if a username is valid.
post
Checks if a username is valid.
post
Destroys the current authentication session while reporting metrics like url and reason for logout.
post
Authenticates as a user given a two step verification verification token.
Advertising
20
Analytics
4
Assets
78
Avatars
35
Badges
26
Bans and blocks
15
Configs
9
Connections
19
Creator Store
8
Data and memory stores
48
Developer products
21
Experiments
11
Game Events
5
Game passes
21
Generative AI
1
Groups
103
Interactions
26
Inventories
9
Localization
89
Luau Execution
5
Matchmaking
29
Metadata
15
Notifications
11
Observability
6
Places
20
Private servers
9
Team Create
8
Thumbnail Personalization
7
Thumbnails
11
Trades
16
Universes
37
User profiles
5
Users
14
post
Reserves a nonce for a native SSO sign-in attempt.
post
OAuth callback for identity providers that POST the authorization code as form fields (Apple form_post). Extra form fields such as Apple's first-auth `id_token` and `user` are ignored; web login exchanges code via PKCE and does not treat a form id_token as proof.
post
SAML Assertion Consumer Service endpoint that external identity provider calls post user authentication.
get
Gets a page of asset (image) entries for the specified table, along with the table's per-locale asset translations.
post
Rename a credential for the specified user.
Accounts
Tries to get a valid username if the current username is taken
get
/v1/validators/username
Query parameters
Username
string
required
BirthDay
string
date-time
required
Response
OK
RobloxAuthenticationApiModelsRecommendedUsernameResponse
required
didGenerateNewUsername
boolean
suggestedUsernames
string[]
Changes