Get Document Split job by ID

Authorizations

Authorization

string

header

required

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

Headers

box-version

enum<string>

required

Version header.

Available options:

2026.0

Path Parameters

document_split_id

string

required

The unique identifier for the Document Split job.

Response

Returns the Document Split job.

A standard representation of a Document Split job. The job represents a request to split a paginated source document into multiple files based on either a manual set of page ranges, a non-linear page selection, or a smart prompt-driven analysis.

string

required

The unique identifier for the Document Split job.

Example:

"1748426"

type

enum<string>

required

The value will always be document_split.

Available options:

document_split

Example:

"document_split"

source_file

File reference · object

required

The file to split.

Show child attributes

status

enum<string>

required

The current state of the Document Split job.

Available options:

submitted,

completed,

failed,

completed_with_error

Example:

"submitted"

split_input

Document Split manual create request · object

required

The caller-supplied input that was used to perform the split. The shape mirrors the request: for a manual split, split_input contains split_type and split_definition; for a page_selection split, split_input contains split_type and page_selection; for a smart split, split_input contains split_type and the caller-supplied prompt. For smart splits, the page ranges that Box produced are exposed under output.split_definition.

Document Split manual create request
Document Split page selection create request
Document Split smart create request

Show child attributes

destination_folder

Folder reference · object

required

The folder that received the generated files.

Show child attributes

input_source

enum<string>

required

The system that initiated the request, used for analytics and traceability.

Available options:

api,

box,

relay,

salesforce

Example:

"api"

output

Document Split output · object

The result of the Document Split job. null until the job has produced output.

Document Split output
OpenAPI 3.0 null schema type

Show child attributes

created_at

string<date-time>

When the Document Split job was created.

Example:

"2023-10-26T15:30:00Z"

created_by

User (Mini) · object

The user who created the Document Split job.

Show child attributes

enterprise

Enterprise reference · object

The enterprise that owns the Document Split job.

Show child attributes

failures

Document Split failures · object

Errors and warnings that occurred during the document split. null when no failures were recorded.

Document Split failures
OpenAPI 3.0 null schema type

Show child attributes

external_id

string

An optional identifier supplied by the caller when the Document Split job was created. Returned for correlation only. It is not a Box resource ID, is not required to be unique, and cannot be used to look up the job.

Maximum string length: 255

Example:

"invoice-48291"

API reference

v2025.0

v2026.0

Get Document Split job by ID

Authorizations

Headers

Path Parameters

Response