/
RO
roblox
Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Accounts
198
get
/service-efficiency-api/v1/accounts/groups/{groupId}
Operation to Get an Account for a Group.
put
/service-efficiency-api/v1/accounts/groups/{groupId}
Operation to Update an Account for a Group.
get
/service-efficiency-api/v1/accounts/users/{userId}
Operation to Get an Account for a User.
put
/service-efficiency-api/v1/accounts/users/{userId}
Operation to Update an Account for a User.
get
/service-efficiency-api/v1/billing_activities/groups/{groupId}
Operation to Get Billing Activities
get
/service-efficiency-api/v1/billing_activities/users/{userId}
Operation to Get Billing Activities
get
/service-efficiency-api/v1/bills/groups/{groupId}
Operation to Get Billing Statement for group owned account.
get
/service-efficiency-api/v1/bills/users/{userId}
Operation to Get Billing Statement for user owned account.
get
/service-efficiency-api/v1/eligibility/groups/{groupId}
Operation to Check the Eligibility of a Group.
get
/service-efficiency-api/v1/eligibility/users/{userId}
Operation to Check the Eligibility of a User.
get
/service-efficiency-api/v1/is_allowed
Endpoint to return whether the current user can access the features in this API, optionally with a universe ID.
get
/service-efficiency-api/v1/payment_profiles/groups/{groupId}/service_efficiency
Operation to Get the Service Efficiency Payment Method for a Group.
put
/service-efficiency-api/v1/payment_profiles/groups/{groupId}/service_efficiency
Operation to Set the Service Efficiency Payment Method for a Group.
get
/service-efficiency-api/v1/payment_profiles/users/{userId}
Operation to List Payment Profiles of a User.
post
/service-efficiency-api/v1/payment_profiles/users/{userId}
Operation to Create Payment Profile for a User.
delete
/service-efficiency-api/v1/payment_profiles/users/{userId}
Operation to Delete a Payment Profile for a User.
get
/service-efficiency-api/v1/payment_profiles/users/{userId}/service_efficiency
Operation to Get the Service Efficiency Payment Method for a User.
put
/service-efficiency-api/v1/payment_profiles/users/{userId}/service_efficiency
Operation to Set the Service Efficiency Payment Method for a User.
post
/service-efficiency-api/v1/payments/groups/{groupId}
Operation to Submit a Manual Payment for a Group.
post
/service-efficiency-api/v1/payments/users/{userId}
Operation to Submit a Manual Payment for a User.
get
/v1/account-creation/metadata
Get metadata for adding auth methods.
get
/v1/account/pin
Gets the account pin status.
post
/v1/account/pin
Request to create the account pin.
delete
/v1/account/pin
Request for deletes the account pin from the account.
patch
/v1/account/pin
Request made to update the account pin on the account.
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.
get
/v1/account/settings/account-country
Get a user's current account country setting.
post
/v1/account/settings/account-country
Updates the user's account country.
get
/v1/account/settings/metadata
Returns metadata used by the account settings page
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/auth/metadata
Gets Auth meta data
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/client-assertion
Creates a client assertion to be used when generating an auth ticket.
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/email
Gets the authenticated user's email address and verified status
post
/v1/email
Updates the authenticated user's email address
patch
/v1/email
Updates the authenticated user's email address
post
/v1/email/verify
Verify the user's email address from token
post
/v1/email/verify#accountsettings.roblox.com
Send verify email to the authenticated user's email address
get
/v1/emails
Gets the authenticated user's verified email and pending (unverified) email if one exists
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/games/multiget-playability-status
Gets a list of universe playability statuses for the authenticated user
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
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).
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/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.
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/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/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.
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/themes/types
returns all the enabled theme types.
get
/v1/themes/{consumerType}/{consumerId}
returns the theme type for a specific consumer.
patch
/v1/themes/{consumerType}/{consumerId}
Modify the theme type for consumer.
get
/v1/trade-privacy
Get a user's trade privacy setting
post
/v1/trade-privacy
Updates a user's trade privacy setting
get
/v1/trade-value
Get a user's trade quality filter setting
post
/v1/trade-value
Updates a user's trade quality filter setting
post
/v1/user/passwords/change
Changes the password 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
get
/v1/usernames/validate
Checks if a username is valid.
post
/v1/usernames/validate
Checks if a username is valid.
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/{userId}/can-view-inventory
Gets whether the specified user's inventory can be viewed.
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}/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/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/auth/metadata
Gets Auth meta data
post
/v2/identity-verification/login
Endpoint for login with identity verification
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/metadata
Get the metadata
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/push-notifications/get-destinations
Gets valid destinations associated with the signed user
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.
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.
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.
post
/v3/logout
Destroys the current authentication session while reporting metrics like url and reason for logout.
post
/v3/users/{userId}/two-step-verification/login
Authenticates as a user given a two step verification verification token.
Advertising
24
Analytics
17
Assets
81
Avatars
36
Badges
29
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
116
Interactions
26
Inventories
9
Localization
96
Luau Execution
5
Matchmaking
33
Metadata
16
Notifications
11
Observability
6
Places
23
Private servers
9
Service Efficiency
2
Team Create
8
Thumbnail Personalization
7
Thumbnails
11
Trades
16
Universes
38
User profiles
5
Users
13
get
/v2/beta-program-channel-version
Get the channel and current version guid of a beta program the currently logged in user may use, whether or not they are opted in to it. Only Studio binary types (MacStudio, WindowsStudio64) are supported for now.
Accounts
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get a user's current account country setting.
get
/v1/account/settings/account-country
Oct 14, 2026
5dcfa33df56a
Revision changes
info
endpoint added
Sep 17, 2026
7c6787738100
Revision changes
breaking
api path removed without deprecation