Box Developer Documentation

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

List parts

get
https://{box-upload-server}/api/2.0
/files/upload_sessions/:upload_session_id/parts

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
D5E3F7A

The ID of the upload session.

Query Parameters

integer (int64)in queryoptional
10001000

The maximum number of items to return per page.

integer (int64)in queryoptional
10000

The offset of the item at which to begin the response.

Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

Response

application/jsonUpload parts

Returns a list of parts that have been uploaded.

application/jsonClient error

An unexpected client error.

get
List parts
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://upload.box.com/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.chunkedUploads.getFileUploadSessionParts(uploadSessionId);
Python Gen
client.chunked_uploads.get_file_upload_session_parts(upload_session_id)
.NET Gen
await client.ChunkedUploads.GetFileUploadSessionPartsAsync(uploadSessionId: uploadSessionId);
Swift Gen (Beta)
try await client.chunkedUploads.getFileUploadSessionParts(uploadSessionId: uploadSessionId)
Java
//The following snippet retrives first 1000 parts that are uploaded.
BoxFileUploadSessionPartList partList = session.listParts(0, 1000);
List<BoxFileUploadSessionPart> parts = partList.getEntries();
Python
parts = client.upload_session('11493C07ED3EABB6E59874D3A1EF3581').get_parts()
for part in parts:
    print(f'Part {part["part_id"]} at offset {part["offset"]} has already been uploaded')
Node
// Get the list of parts already uploaded
client.files.getUploadSessionParts('93D9A837B45F', {limit: 100}, callback);

Response Example

{
  "entries": [
    {
      "part_id": "6F2D3486",
      "offset": 16777216,
      "size": 3222784,
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}