/
RO
roblox
/
Roblox API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 3h ago · Updated 3h ago
View markdown
roblox
Roblox API
get
Get the user's description
OpenAPI 3.0.4
2026-08-18
812
1,119
3.1 MB
40ce8069acc1
Accounts
83
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
Get the user's birthdate
post
Update the user's birthdate
get
Get the user's birthdate
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
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
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
Gets two step verification system metadata.
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
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
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
Gets valid destinations associated with the signed user
Advertising
20
Analytics
4
Assets
74
Avatars
31
Badges
26
Bans and blocks
15
Configs
9
Connections
19
Creator Store
8
Data and memory stores
48
Developer products
21
Game Events
5
Game passes
21
Generative AI
1
Groups
103
Interactions
26
Inventories
9
Localization
94
Luau Execution
5
Matchmaking
29
Metadata
16
Notifications
11
Places
23
Private servers
9
Team Create
8
Thumbnail Personalization
7
Thumbnails
11
Trades
16
Universes
41
User profiles
5
Users
14
Accounts
User profiles
Get the user's description
get
/v1/description#users.roblox.com
Response
OK
RobloxUsersApiDescriptionResponse
required
The description response
description
string
The description