---
title: "List folder locks"
method: GET
path: "/folder_locks"
tags: ["Folder Locks"]
---

# List folder locks

`GET /folder_locks`

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

## Query parameters

- `folder_id` string, required

## Response `200`

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

- FolderLocks — A list of folder locks.
  - `entries` FolderLock[] — A list of folder locks.
    - `folder` object — The folder that the lock applies to.
      - `id` string, required — The unique identifier that represent a folder. The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.
      - `etag` string, nullable — The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.
      - `type` 'folder', required — The value will always be `folder`.
      - `sequence_id` string — A numeric identifier that represents the most recent user event that has been applied to this item. This can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read. An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.
      - `name` string — The name of the folder.
    - `id` string — The unique identifier for this folder lock.
    - `type` string — The object type, always `folder_lock`.
    - `created_by` object — The user or group that created the lock.
      - `id` string, required — The unique identifier for this user.
      - `type` 'user', required — The value will always be `user`.
    - `created_at` string, date-time — When the folder lock object was created.
    - `locked_operations` object — The operations that have been locked. Currently the `move` and `delete` operations cannot be locked separately, and both need to be set to `true`.
      - `move` boolean, required — Whether moving the folder is restricted.
      - `delete` boolean, required — Whether deleting the folder is restricted.
    - `lock_type` string — The lock type, always `freeze`.
  - `limit` string — 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.
  - `next_marker` string, nullable — The marker for the start of the next page of results.

## Other responses

- `403` — Returned when the access token provided in the `Authorization` header is not recognized or not provided.
- `404` — Returned if the folder is not found, or the user does not have access to the folder.
- `405` — Returned if the `folder_id` is not in a recognized format.
- `default` — An unexpected client error.

---

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