List folder locks on folder


Retrieves folder lock details for a given folder.



Query Parameters

stringin queryrequired

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://* the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.


application/jsonFolder Locks

Returns details for all folder locks applied to the folder, including the lock type and user that applied the lock.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the folder is not found, or the user does not have access to the folder.

application/jsonClient error

Returned if the folder_id is not in a recognized format.

application/jsonClient error

An unexpected client error.

List folder locks on folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Response Example

  "entries": [
      "folder": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      "id": 12345678,
      "type": "folder_lock",
      "created_by": {
        "id": 11446498,
        "type": "user"
      "created_at": "2020-09-14T23:12:53Z",
      "locked_operations": {
        "move": true,
        "delete": true
      "lock_type": "freeze"
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000