Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!List 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.
Request
Query Parameters
12345The 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://*.app.box.com/folder/123
the folder_id is 123.
The root folder of a Box account is
always represented by the ID 0.
Response
Returns details for all folder locks applied to the folder, including the lock type and user that applied the lock.
Returned when the access token provided in the Authorization header
is not recognized or not provided.
Returned if the folder is not found, or the user does not have access to the folder.
Returned if the folder_id is not in a recognized format.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/folder_locks?folder_id=33552487093" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.folderLocks.getFolderLocks({
folderId: folder.id,
} satisfies GetFolderLocksQueryParams);client.folder_locks.get_folder_locks(folder.id)await client.FolderLocks.GetFolderLocksAsync(queryParams: new GetFolderLocksQueryParams(folderId: folder.Id));try await client.folderLocks.getFolderLocks(queryParams: GetFolderLocksQueryParams(folderId: folder.id))client.folders.listLocks(folderId: "22222") { results in
switch results {
case let .success(iterator):
for i in 1 ... 10 {
iterator.next { result in
switch result {
case let .success(folderLock):
print("- \(folderLock.id)")
case let .failure(error):
print(error)
}
}
}
case let .failure(error):
print(error)
}
}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": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}