---
title: "List User Restrictions"
method: GET
path: "/cloud/v2/universes/{universe_id}/user-restrictions"
tags: ["Bans and blocks", "Universes", "Users"]
---

# List User Restrictions

`GET /cloud/v2/universes/{universe_id}/user-restrictions`

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

## Path parameters

- `universe_id` string, required

## Query parameters

- `maxPageSize` integer
- `pageToken` string

## Response `200`

OK

- ListUserRestrictionsResponse — A list of UserRestrictions in the parent collection.
  - `userRestrictions` UserRestriction[] — The UserRestrictions from the specified Universe or Place.
    - `path` string — The resource path of the user restriction. Formats: * `universes/{universe_id}/user-restrictions/{user_restriction_id}` * `universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}`
    - `updateTime` string, date-time — The timestamp when the user restriction was last updated.
    - `user` string — The affected user.
    - `gameJoinRestriction` UserRestrictionGameJoinRestriction — A restriction means the affected user will not be able to join the parent universe or place, and will be kicked if currently joined.
      - `active` boolean — By default, this is false since a user's access to an experience is not restricted to begin with. If this is set to true at the experience level, this becomes true automatically at the place level for all places in the experience.
      - `startTime` string, date-time — The start time of the restriction.
      - `duration` string, duration — The duration of the restriction. If not specified, the restriction is permanent. If specified, the range must be from 1 second to 315,576,000,000 seconds, inclusive. Durations with sub-second precision are not permitted.
      - `privateReason` string — The reason the restriction was created. This field *is not* displayed to the user. 1,000 character maximum.
      - `displayReason` string — The user-facing reason the restriction was created. This field *is* displayed to the user. 400 character maximum.
      - `excludeAltAccounts` boolean — When true, the restriction will not be be propagated to alt accounts. Defaults to false.
      - `inherited` boolean — This is true when the restriction doesn't directly apply to the parent resource, but to some other ancestor resource. For example, if a user restriction exists on universes/123, then any places within that universe from which the user was not explicitly restricted will have an inherited restriction and this field will be `true`.
  - `nextPageToken` string — 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.

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/revisions/80880b69892d/schema)