/

Search skmtc

⌘K

Docs
History
Schema
Generate

Filter operations

Accounts198

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_allowedEndpoint 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_efficiencyOperation to Get the Service Efficiency Payment Method for a Group.
put/service-efficiency-api/v1/payment_profiles/groups/{groupId}/service_efficiencyOperation 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_efficiencyOperation to Get the Service Efficiency Payment Method for a User.
put/service-efficiency-api/v1/payment_profiles/users/{userId}/service_efficiencyOperation 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/metadataGet metadata for adding auth methods.
get/v1/account/pinGets the account pin status.
post/v1/account/pinRequest to create the account pin.
delete/v1/account/pinRequest for deletes the account pin from the account.
patch/v1/account/pinRequest made to update the account pin on the account.
post/v1/account/pin/lockRequest to locks the account which has an account pin enabled.
post/v1/account/pin/unlockRequests to unlock the account pin.
get/v1/account/settings/account-countryGet a user's current account country setting.
post/v1/account/settings/account-countryUpdates the user's account country.
get/v1/account/settings/metadataReturns metadata used by the account settings page
post/v1/account/upgradeAttaches a sign-in credential to the calling account.
get/v1/announcementsMigrate from RobloxWebsite project, return news notification for Private Message page
get/v1/announcements/metadata
get/v1/auth/metadataGets Auth meta data
get/v1/birthdateGet the user's birthdate
post/v1/birthdateUpdate the user's birthdate
get/v1/birthdate#users.roblox.comGet the user's birthdate
get/v1/client-assertionCreates a client assertion to be used when generating an auth ticket.
get/v1/descriptionGet the user's description
post/v1/descriptionUpdate the user's description
get/v1/description#users.roblox.comGet the user's description
post/v1/description#users.roblox.comUpdate the user's description
get/v1/emailGets the authenticated user's email address and verified status
post/v1/emailUpdates the authenticated user's email address
patch/v1/emailUpdates the authenticated user's email address
post/v1/email/verifyVerify the user's email address from token
post/v1/email/verify#accountsettings.roblox.comSend verify email to the authenticated user's email address
get/v1/emailsGets the authenticated user's verified email and pending (unverified) email if one exists
post/v1/external/accessSigns a user up for Roblox and links the account to the authenticated external provider ID.
post/v1/external/loginLogs in a user to Roblox based on the user's authenticated external provider session
post/v1/external/loginAndLinkDeprecated endpoint Logins in a user to Roblox, then links the Roblox account to the external provider ID
post/v1/external/signupSigns a user up for Roblox and links the account to the authenticated external provider ID
post/v1/external/unlinkUnlink the logged in Roblox account from the current external provider ID
post/v1/external/{identityProviderId}/sso/native/nonceReserves a nonce for a native SSO sign-in attempt.
get/v1/external/{identityProviderId}/sso/oauth/callbackOAuth callback for identity providers that return the authorization code on a GET redirect (Okta, Google).
post/v1/external/{identityProviderId}/sso/oauth/callbackOAuth 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/initSigns 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-serviceSAML Assertion Consumer Service endpoint that external identity provider calls post user authentication.
get/v1/games/multiget-playability-statusGets a list of universe playability statuses for the authenticated user
get/v1/genderGet the user's gender
post/v1/genderUpdate the user's gender
get/v1/gender#users.roblox.comGet the user's gender
post/v1/gender#users.roblox.comUpdate the user's gender
post/v1/identity-verification/loginEndpoint for login with identity verification
post/v1/identity/initialize-loginInitiates identifier-first login flow by returning a list of login methods for user(s).
post/v1/loginAuthenticates a user.
post/v1/login/linkedEndpoint for logging in a user, specifically for linked authentication on PCGDK
post/v1/logoutDestroys the current authentication session.
post/v1/logoutfromallsessionsandreauthenticateLogs out user from all other sessions.
get/v1/messagesGets a user's messages.
post/v1/messages/archiveArchives a batch of messages.
post/v1/messages/mark-readMarks a batch of messages as read.
post/v1/messages/mark-unreadMarks a batch of messages as unread.
post/v1/messages/unarchiveUnarchives a batch of messages.
get/v1/messages/unread/countGets unread messages for the authenticated user.
get/v1/messages/{messageId}Gets a message's details.
get/v1/metadataGet the metadata
get/v1/metadata#auth.roblox.comGet the metadata
get/v1/metadata#twostepverification.roblox.comGets two step verification system metadata.
post/v1/passkey/DeleteCredentialBatchDisables a batch of credentials for the specified user.
post/v1/passkey/FinishRegistrationComplete Passkey registration by providing credential creation options.
post/v1/passkey/ListCredentialsList a user's registered passkeys.
post/v1/passkey/RenameCredentialRename a credential for the specified user.
post/v1/passkey/StartAuthenticationProvides a challenge for the Passkey to authenticate.
post/v1/passkey/StartRegistrationInitiates Passkey registration by providing credential creation options.
post/v1/passkey/finish-ar-preauth-registrationFinishes 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-userInitializes passkey authentication for the user(s) corresponding to the identifier provided.
post/v1/passkey/start-preauth-registrationInitiates Passkey preauthenticated registration by providing credential creation options.
get/v1/passkey/su-eligibilityChecks whether the authenticated user is eligible for silent passkey upgrade. Route and response are intentionally obfuscated ("su-eligibility" = "silent-upgrade-eligibility").
get/v1/passwords/validateEndpoint for checking if a password is valid.
post/v1/passwords/validateEndpoint for checking if a password is valid.
get/v1/phoneGet Verified Phone Number
post/v1/phoneSet Phone Number
post/v1/phone/deleteDelete Phone
post/v1/phone/resendResend Phone code
post/v1/phone/verifyVerify Phone
get/v1/promotion-channelsGet the user's promotion channels
post/v1/promotion-channelsUpdate the user's promotion channels
get/v1/recovery/metadataGet metadata for forgot endpoints
get/v1/revert/accountGet Revert Account ticket info
post/v1/revert/accountSubmit Revert Account Request
post/v1/revert/invalidate-ticketsInvalidates 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/refreshLogs out user from the current session and create a new one.
post/v1/signupEndpoint for signing up a new user
post/v1/signup/linkedEndpoint for signing up a new user through linked authentication.
get/v1/social/connected-providersGet social network user information if the given social auth method is connected to current user.
post/v1/social/{provider}/disconnectRemoves the given social authentication method from current Roblox user if it is connected.
get/v1/themes/typesreturns 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-privacyGet a user's trade privacy setting
post/v1/trade-privacyUpdates a user's trade privacy setting
get/v1/trade-valueGet a user's trade quality filter setting
post/v1/trade-valueUpdates a user's trade quality filter setting
post/v1/user/passwords/changeChanges the password for the authenticated user.
post/v1/usernameChange the user's username
get/v1/username/change/priceGet the current price for a username change
get/v1/usernamesGets a list of existing usernames on Roblox based on the query parameters
post/v1/usernames/recoverSends an email of all accounts belonging to an email
get/v1/usernames/validateChecks if a username is valid.
post/v1/usernames/validateChecks if a username is valid.
get/v1/users/authenticatedGets the minimal authenticated user.
get/v1/users/authenticated/age-bracketGets the age bracket of the authenticated user.
get/v1/users/authenticated/country-codeGets the country code of the authenticated user.
get/v1/users/authenticated/rolesGets the (public) roles of the authenticated user, such as `"Soothsayer"` and `"BetaTester"`.
get/v1/users/{userId}/can-view-inventoryGets whether the specified user's inventory can be viewed.
post/v1/users/{userId}/challenges/authenticator/verifyVerifies a two step verification challenge code via authenticator app.
post/v1/users/{userId}/challenges/cross-device/retractReverts a user's dialog state from ACTIVE to PENDING.
post/v1/users/{userId}/challenges/cross-device/retryRetry a Cross Device two step verification approval.
post/v1/users/{userId}/challenges/cross-device/verifyVerifies a two step verification approval via Cross Device. Cross Device approval does not use a verification code.
post/v1/users/{userId}/challenges/email/send-codeSends a two step verification challenge code via email.
post/v1/users/{userId}/challenges/email/verifyVerifies a two step verification challenge with a code sent via email.
post/v1/users/{userId}/challenges/passkey/verify-finishValidates the assertion data returned by the passkey.
post/v1/users/{userId}/challenges/passkey/verify-startProvides a challenge for the passkey to authenticate.
post/v1/users/{userId}/challenges/password/verifyVerifies a two step verification challenge with a password (code).
post/v1/users/{userId}/challenges/recovery-codes/verifyVerifies a two step verification challenge via a recovery code.
post/v1/users/{userId}/challenges/security-key/verify-finishValidates the assertion data returned by the security key.
post/v1/users/{userId}/challenges/security-key/verify-startProvides a challenge for the security key to authenticate.
post/v1/users/{userId}/challenges/sms/send-codeSends a two step verification code via SMS for the specified user.
post/v1/users/{userId}/challenges/sms/verifyVerifies a two step verification challenge with a code sent via SMS.
get/v1/users/{userId}/configurationGets two step verification configuration for the specified user.
post/v1/users/{userId}/configuration/authenticator/disableDisables two step verification via authenticator for the specified user.
post/v1/users/{userId}/configuration/authenticator/enableInitiates enabling authenticator-based two step verification for the specified user.
post/v1/users/{userId}/configuration/authenticator/enable-verifyFinishes enabling authenticator-based two step verification for the specified user.
post/v1/users/{userId}/configuration/email/disableDisables two step verification via email for the specified user.
post/v1/users/{userId}/configuration/email/enableEnables two step verification via email for the specified user.
post/v1/users/{userId}/configuration/security-key/disableDisables a batch of credentials for the specified user.
post/v1/users/{userId}/configuration/security-key/enableInitiates security key registration by providing credential creation options.
post/v1/users/{userId}/configuration/security-key/enable-verifyFinishes 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/listList a user's registered security keys.
post/v1/users/{userId}/configuration/sms/disableDisables two step verification via SMS for the specified user.
post/v1/users/{userId}/configuration/sms/enableEnables two step verification via SMS for the specified user.
get/v1/users/{userId}/promotion-channelsGet promotion channels for a given user ID
get/v1/users/{userId}/recovery-codesGets the current status of recovery codes for a user.
post/v1/users/{userId}/recovery-codes/clearClears any existing recovery codes for the user.
post/v1/users/{userId}/recovery-codes/regenerateClears any existing recovery codes and generates a new batch of recovery codes.
get/v1/users/{userId}/roblox-badgesReturns a list of Roblox badges belonging to a user.
get/v1/validators/emailTries to check if an email is valid
get/v1/validators/recommendedUsernameFromDisplayNameValidates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.
post/v1/validators/recommendedUsernameFromDisplayNameValidates 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/usernameTries to get a valid username if the current username is taken
post/v1/validators/usernameTries 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/connectionCheck if the current user has an Xbox connected. Also returns the gamertag of the Xbox account if connected.
post/v1/xbox/disconnectUnlink the current ROBLOX account from the Xbox live account.
get/v1/xbox/get-login-consecutive-daysGet the consecutive days the xbox user has been logged in.
post/v1/xbox/translateTranslate the xbox user to roblox user.
get/v2/auth/metadataGets Auth meta data
post/v2/identity-verification/loginEndpoint for login with identity verification
post/v2/loginAuthenticates a user.
post/v2/login/linkedEndpoint for logging in a user, specifically for linked authentication on PCGDK
post/v2/logoutDestroys the current authentication session.
post/v2/logoutfromallsessionsandreauthenticateLogs out user from all other sessions.
get/v2/metadataGet the metadata
get/v2/passwords/current-statusReturns password status for current user, asynchronously.
get/v2/passwords/resetGets metadata needed for the password reset view.
post/v2/passwords/resetResets a password for a user that belongs to the password reset ticket.
post/v2/passwords/reset/sendSends a password reset email or challenge to the specified target.
post/v2/passwords/reset/verifyVerifies a password reset challenge solution.
get/v2/passwords/validateEndpoint for checking if a password is valid.
post/v2/passwords/validateEndpoint for checking if a password is valid.
get/v2/push-notifications/get-destinationsGets valid destinations associated with the signed user
get/v2/recovery/metadataGet metadata for forgot endpoints
get/v2/revert/accountGet Revert Account ticket info
post/v2/revert/accountSubmit Revert Account Request
post/v2/revert/invalidate-ticketsInvalidates 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/refreshLogs out user from the current session and create a new one.
post/v2/signupEndpoint for signing up a new user
post/v2/signup/linkedEndpoint for signing up a new user through linked authentication.
post/v2/user/passwords/changeChanges the password for the authenticated user.
post/v2/usernameChange the user's username
get/v2/username/change/priceGet the current price for a username change
get/v2/usernamesGets a list of existing usernames on Roblox based on the query parameters
post/v2/usernames/recoverSends an email of all accounts belonging to an email
get/v2/usernames/validateChecks if a username is valid.
post/v2/usernames/validateChecks if a username is valid.
post/v3/logoutDestroys the current authentication session while reporting metrics like url and reason for logout.
post/v3/users/{userId}/two-step-verification/loginAuthenticates as a user given a two step verification verification token.

Advertising24

Analytics17

Assets81

Avatars36

Badges29

Bans and blocks15

Configs9

Connections19

Creator Store8

Data and memory stores48

Developer products21

Experiments11

Game Events5

Game passes21

Generative AI1

Groups116

Interactions26

Inventories9

Localization96

Luau Execution5

Matchmaking33

Metadata16

Notifications11

Observability6

Places23

Private servers9

Service Efficiency2

Team Create8

Thumbnail Personalization7

Thumbnails11

Trades16

Universes38

User profiles5

Users13

get/v2/beta-program-channel-versionGet 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

Changes to Checks if a username is valid.

get/v2/usernames/validate

Sep 3, 2026d9b4ae8b3380 Revision changes
- info
  endpoint added