Box Developer Documentation
Log in

Get Folder Lock

Guides Folders Single Folders Get Folder Lock
Edit this page

Get Folder Lock

To get a list of the current locks on a folder in Box, call the GET /folder_locks/ API with the id of the folder supplied as a folder_id query string parameter.

Folder Locks

When using any folder lock API endpoints, you must be authenticated as the owner/co-owner of the folder you are trying to access.

cURL
curl -i -X GET "https://api.box.com/2.0/folder_locks?folder_id=33552487093" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.folderLocks.getFolderLocks({
  folderId: folder.id,
} satisfies GetFolderLocksQueryParams);
Python Gen
client.folder_locks.get_folder_locks(folder.id)
.NET Gen
await client.FolderLocks.GetFolderLocksAsync(queryParams: new GetFolderLocksQueryParams(folderId: folder.Id));
Swift Gen (Beta)
try await client.folderLocks.getFolderLocks(queryParams: GetFolderLocksQueryParams(folderId: folder.id))
Java Gen (Beta)
client.getFolderLocks().getFolderLocks(new GetFolderLocksQueryParams(folder.getId()))

Folder ID

The id of 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/folder/123 the folder_id is 123.