User

Attributes

pathstring

createTimestring

idstring

namestring

displayNamestring

aboutstring

localestring

premiumboolean

idVerifiedboolean

socialNetworkProfilesobject

Base URL

https://apis.roblox.com/cloud
The User Resource

{
"path": "string",
"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"
}
}

Get User

GET /v2/users/{user}
RequestPath Parameters
userstringRequired

ResponseUser
GET /v2/users/{user}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user}' \
-H 'x-api-key: {your-api-key}'
Response

{
"path": "string",
"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"
}
}

Generate User Thumbnail

GET /v2/users/{user}:generateThumbnail
RequestPath Parameters
userstringRequired

Query Parameters
sizenumber

formatstring

shapestring

Response
Response
imageUristring

Metadata
GET /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}'