Latest version
Get Box Doc Gen job by ID
API version 2025.0
Get details of the Box Doc Gen job.
Request
bearer [ACCESS_TOKEN]
application/json
Request Headers
stringin headerrequired
Version header.
Value is always 2025.0
Path Parameters
stringin pathrequired
123Box Doc Gen job ID.
Response
application/jsonBox Doc Gen job
Details of the Box Doc Gen job.
application/jsonClient error
The client does not have access rights to the content or resource requested.
application/jsonClient error
Returned if the job is not found or the user does not have access to the associated job.
application/jsonClient error
The user has sent too many requests in a given amount of time.
application/jsonClient error
An unexpected condition was encountered on the server.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/docgen_jobs/12345" \
-H 'box-version: 2025.0' \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.docgen.getDocgenJobByIdV2025R0(docgenJobItemFromList.id);Python v10
client.docgen.get_docgen_job_by_id_v2025_r0(docgen_job_item_from_list.id).NET v10
await client.Docgen.GetDocgenJobByIdV2025R0Async(jobId: docgenJobItemFromList.Id);Swift v10
try await client.docgen.getDocgenJobByIdV2025R0(jobId: docgenJobItemFromList.id)Java v10
client.getDocgen().getDocgenJobByIdV2025R0(docgenJobItemFromList.getId())Response Example
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"output_file": {
"id": "42037322",
"type": "file"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"output_type": "docx",
"status": "completed",
"template_file": {
"id": "42037322",
"type": "file"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
}
}