User

Represents any registered user of Roblox.

Attributes

pathstring

The resource path of the user.

Format: users/{user_id}.

createTimestring
Output Only

The timestamp at which the user was created. This string is formatted as a Timestamp.

idstring
Output Only

Unique ID that identifies a user in Roblox.

namestring

Unique username for a user in Roblox.

displayNamestring

Display name for the user.

aboutstring

User-defined information about themselves.

localestring

Current locale selected by the user. Returns IETF language code.

premiumboolean
Output Only

Whether the user is a premium user.

idVerifiedboolean
Output Only

Specifies if the user is ID-verified.

To access this data, you need an API key / OAuth token with the following scope: user.advanced:read.

socialNetworkProfilesobject

User's social network profiles and visibility.

Base URL
https://apis.roblox.com
The User Resource
{

  "path": "users/123",

  "createTime": "2023-07-05T12:34:56Z",

  "id": "123456",

  "name": "exampleUser",

  "displayName": "userDefinedName",

  "about": "Example User's bio",

  "locale": "en-US",

  "premium": true,

  "idVerified": true,

  "socialNetworkProfiles": {

    "facebook": "string",

    "twitter": "string",

    "youtube": "string",

    "twitch": "string",

    "guilded": "string",

    "visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"

  }

}

User

Get User
Beta

GET /cloud/v2/users/{user_id}

Gets a user's basic and advanced information.

To access a user's public information, no additional scopes are required.

To access a user's verification status, you need the following scopes:

  • user.advanced:read

To access a user's social account information, you need the following scopes:

  • user.social:read
RequestPath Parameters
user_idstring
Required

The user ID.

ResponseUser
GET /cloud/v2/users/{user_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "path": "users/123",

  "createTime": "2023-07-05T12:34:56Z",

  "id": "123456",

  "name": "exampleUser",

  "displayName": "userDefinedName",

  "about": "Example User's bio",

  "locale": "en-US",

  "premium": true,

  "idVerified": true,

  "socialNetworkProfiles": {

    "facebook": "string",

    "twitter": "string",

    "youtube": "string",

    "twitch": "string",

    "guilded": "string",

    "visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"

  }

}

User

Generate User Thumbnail
Beta

GET /cloud/v2/users/{user_id}:generateThumbnail

Generates and returns the URL for the user's avatar thumbnail.

RequestPath Parameters
user_idstring
Required

The user ID.

Query Parameters
sizenumber

Size of the generated thumbnail. The generated thumbnail will have size * size dimension.

Currently supported values: 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720 Default is 420.

formatEnum<string>

Specify the format of the generated thumbnail. Default is PNG.

Possible values:

ValueDescription
FORMAT_UNSPECIFIEDDefault UserThumbnail Format -- set to png
PNGGenerate thumbnail in .png format
JPEGGenerate thumbnail in .jpg format
shapeEnum<string>

Specify the shape of the thumbnail. Default is ROUND (circular).

Possible values:

ValueDescription
SHAPE_UNSPECIFIEDDefault UserThumbnail Shape -- set to round
ROUNDGenerate thumbnail as a circle.
SQUAREGenerate thumbnail as a rectangle.
Response

This method is asynchronous and returns an Operation, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the documentation on long-running operations for more information.

The following sections describe the response and metadata objects that are provided when an operation completes.

Response

Returns the URL for the user's avatar thumbnail.

imageUristring

URI for the generated thumbnail.

Metadata

None

GET /cloud/v2/users/{user_id}:generateThumbnail
curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}:generateThumbnail?size={integer}&format={string}&shape={string}' \

  -H 'x-api-key: {your-api-key}'