Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Folder Locks

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

A list of folder locks.

Folder Lock array

A list of folder locks.

string
1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The marker for the start of the next page of results.

Response Example

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