Skip to main content
GET
/
files
/
{file_id}
/
thumbnail.
{extension}
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/thumbnail.png" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
"<string>"
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_id
string
required

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

​
extension
enum<string>
required

The file format for the thumbnail.

Available options:
png,
jpg

Query Parameters

​
min_height
integer

The minimum height of the thumbnail.

Required range: 32 <= x <= 320
​
min_width
integer

The minimum width of the thumbnail.

Required range: 32 <= x <= 320
​
max_height
integer

The maximum height of the thumbnail.

Required range: 32 <= x <= 320
​
max_width
integer

The maximum width of the thumbnail.

Required range: 32 <= x <= 320

Response

When a thumbnail can be created the thumbnail data will be returned in the body of the response.

The thumbnail.