User

Attributes

pathstring
createTimestring
Output Only
idstring
Output Only
namestring
displayNamestring
aboutstring
localestring
premiumboolean
Output Only
idVerifiedboolean
Output Only
socialNetworkProfilesobject
Base URL

https://apis.roblox.com/cloud
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}
RequestPath Parameters
userstring
Required
ResponseUser
GET /cloud/v2/users/{user}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user}' \
-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}:generateThumbnail
RequestPath Parameters
userstring
Required
Query Parameters
sizenumber
formatEnum<string>
shapeEnum<string>
Response
Response
imageUristring
Metadata
GET /cloud/v2/users/{user}:generateThumbnail

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