ROroblox
Users

Get User

Changed on

Gets a user's basic and advanced information.

get/cloud/v2/users/{user_id}

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/users/{user_id}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

user_idstring required

The user ID.

Response

OK

pathstring nullable

The resource path of the user.

Format: users/{user_id}

createTimestring date-time nullable

The timestamp at which the user was created.

idstring nullable

Unique ID that identifies a user in Roblox.

namestring nullable

Unique username for a user in Roblox.

displayNamestring nullable

Display name for the user.

aboutstring nullable

User-defined information about themselves.

localestring nullable

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

premiumboolean

Whether the user is a premium user.

idVerifiedboolean nullable

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. The field is omitted from the response when the caller is not authorized to read it.

Changes

  • ce82f06a4ba6Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status