Box Developer Documentation
Log in
Latest version

Get Box Doc Gen job by ID

get
https://api.box.com/2.0
/docgen_jobs/:job_id

Get details of the Box Doc Gen job.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header

Value is always 2025.0

Path Parameters

stringin pathrequired
123

Box 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.

get
Get Box Doc Gen job by ID
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://api.box.com/2.0/docgen_jobs/12345" \
     -H 'box-version: 2025.0' \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.docgen.getDocgenJobByIdV2025R0(docgenJobs.entries![0].id);
Python Gen
client.docgen.get_docgen_job_by_id_v2025_r0(docgen_jobs.entries[0].id)
.NET Gen
await client.Docgen.GetDocgenJobByIdV2025R0Async(jobId: NullableUtils.Unwrap(docgenJobs.Entries)[0].Id);
Swift Gen (Beta)
try await client.docgen.getDocgenJobByIdV2025R0(jobId: docgenJobs.entries![0].id)

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"
  }
}