Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Box Doc Gen jobs

A list of Box Doc Gen jobs with a standard set of parameters.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

Box Doc Gen job array

List of jobs.

integer (int64)
1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The marker for the start of the next page of results.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih

The marker for the start of the previous page of results.

Response Example

{
  "entries": [
    {
      "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"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}