Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Users

Get User

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
get/cloud/v2/users/{user_id}

Path parameters

user_idstring required

The user ID.

Response

OK

pathstring

The resource path of the user.

Format: users/{user_id}

createTimestring date-time

The timestamp at which the user was created.

idstring

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

Whether the user is a premium user.

idVerifiedboolean

Specifies if the user is identity-verified. Verification includes, but isn't limited to, non-VoIP phone numbers or government IDs.

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

Example 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": {
    "visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"
  }
}