ROroblox
Bans and blocks
Places
Universes
Users

List User Restrictions

Changed on

List user restrictions for users that have ever been banned in either a universe or a specific place.

get/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions
  • 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 scopes: universe.user-restriction:read

Path parameters

universe_idstring required

The universe ID.

place_idstring required

The place ID.

Query parameters

maxPageSizeinteger

The maximum number of user restrictions to return. The service might return fewer than this value. If unspecified, at most 10 user restrictions are returned. The maximum value is 100 and higher values are set to 100.

pageTokenstring

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

Response

OK

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

Example response

{
  "userRestrictions": [
    {
      "path": "universes/123/user-restrictions/123",
      "updateTime": "2023-07-05T12:34:56Z",
      "user": "users/156",
      "gameJoinRestriction": {
        "active": true,
        "startTime": "2023-07-05T12:34:56Z",
        "duration": "3s",
        "privateReason": "some private reason",
        "displayReason": "some display reason",
        "excludeAltAccounts": true,
        "inherited": true
      }
    }
  ]
}

Changes

  • 5dcfa33df56aRevision changes
    • info

      the security scope universe.user-restriction:read was added to the endpoint's security scheme roblox-oauth2