Skip to main content
Box Doc Gen automatically generates documents from Box Doc Gen templates. These resources represent the generation jobs and batches returned by the Box Doc Gen endpoints, including their status and output files.

​
Box Doc Gen batch (Base)

The basic representation of a Box Doc Gen batch object. A Box Doc Gen batch contains one or more Box Doc Gen jobs.
PropertyTypeRequiredDescription
idstringYesThe unique identifier that represents a Box Doc Gen batch.
typeenum<string>YesThe value will always be docgen_batch. Available options: docgen_batch.
Example
{
  "id": "12345",
  "type": "docgen_batch"
}

​
Box Doc Gen job

A standard representation of a Box Doc Gen job.
PropertyTypeRequiredDescription
idstringYesThe unique identifier that represent a Box Doc Gen job.
typeenum<string>YesThe value will always be docgen_job. Available options: docgen_job.
batchBox Doc Gen batch (Base)YesBox Doc Gen batch that the job belongs to.
template_fileFile referenceYesBox Doc Gen template used in the job.
template_file_versionFile version (Base)YesFile version of a template.
output_fileFile referenceNoThe output file of the job. This property is null until the job is completed. Can be null.
output_file_versionFile version (Base)NoFile version of the output file. This property is null until the job is completed. Can be null.
statusenum<string>YesStatus of the job. Available options: submitted, completed, failed, completed_with_error, pending.
output_typestringYesType of the generated file.
failuresobjectNoErrors and warnings that occurred during document generation. Can be null.
Example
{
  "id": "12345",
  "type": "docgen_job",
  "batch": {
    "id": "12345",
    "type": "docgen_batch"
  },
  "template_file": {
    "type": "file",
    "id": "42037322"
  },
  "template_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "output_file": {
    "type": "file",
    "id": "42037322"
  },
  "output_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "status": "completed",
  "output_type": "docx",
  "failures": {
    "errors": [
      "The tag 'customer_name' was not provided in the input data."
    ],
    "warnings": [
      "The tag 'optional_field' was provided but not used in the template."
    ]
  }
}

​
Box Doc Gen job (Base)

The basic representation of a Box Doc Gen job.
PropertyTypeRequiredDescription
idstringYesThe unique identifier that represent a Box Doc Gen job.
typeenum<string>YesThe value will always be docgen_job. Available options: docgen_job.
Example
{
  "id": "12345",
  "type": "docgen_job"
}

​
Box Doc Gen job (Full)

A full representation of a Box Doc Gen job.
PropertyTypeRequiredDescription
idstringYesThe unique identifier that represent a Box Doc Gen job.
typeenum<string>YesThe value will always be docgen_job. Available options: docgen_job.
batchBox Doc Gen batch (Base)YesBox Doc Gen batch that the job belongs to.
template_fileFile referenceYesBox Doc Gen template used in the job.
template_file_versionFile version (Base)YesFile version of a template.
output_fileFile referenceNoThe output file of the job. This property is null until the job is completed. Can be null.
output_file_versionFile version (Base)NoFile version of the output file. This property is null until the job is completed. Can be null.
statusenum<string>YesStatus of the job. Available options: submitted, completed, failed, completed_with_error, pending.
output_typestringYesType of the generated file.
failuresobjectNoErrors and warnings that occurred during document generation. Can be null.
created_atstringNoTime of job creation. Read-only.
created_byUser (Base)YesUser who created the job.
enterpriseEnterprise referenceYesID of the enterprise.
sourcestringYesSource of the request. Read-only.
Example
{
  "id": "12345",
  "type": "docgen_job",
  "batch": {
    "id": "12345",
    "type": "docgen_batch"
  },
  "template_file": {
    "type": "file",
    "id": "42037322"
  },
  "template_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "output_file": {
    "type": "file",
    "id": "42037322"
  },
  "output_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "status": "completed",
  "output_type": "docx",
  "failures": {
    "errors": [
      "The tag 'customer_name' was not provided in the input data."
    ],
    "warnings": [
      "The tag 'optional_field' was provided but not used in the template."
    ]
  },
  "created_at": "2022-05-11T10:56:11-07:00",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "source": "api"
}

​
Box Doc Gen jobs

A list of Box Doc Gen jobs with a standard set of parameters.
PropertyTypeRequiredDescription
limitintegerNoThe 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.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
prev_markerstringNoThe marker for the start of the previous page of results. Can be null.
entriesarray of Box Doc Gen jobNoList of jobs.
Example
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "template_file": {
        "type": "file",
        "id": "42037322"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "output_file": {
        "type": "file",
        "id": "42037322"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "status": "completed",
      "output_type": "docx",
      "failures": {
        "errors": [
          "The tag 'customer_name' was not provided in the input data."
        ],
        "warnings": [
          "The tag 'optional_field' was provided but not used in the template."
        ]
      }
    }
  ]
}

​
Box Doc Gen jobs (Full)

A list of Box Doc Gen jobs with a full set of parameters.
PropertyTypeRequiredDescription
limitintegerNoThe 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.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
prev_markerstringNoThe marker for the start of the previous page of results. Can be null.
entriesarray of Box Doc Gen job (Full)NoList of jobs.
Example
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "template_file": {
        "type": "file",
        "id": "42037322"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "output_file": {
        "type": "file",
        "id": "42037322"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "status": "completed",
      "output_type": "docx",
      "failures": {
        "errors": [
          "The tag 'customer_name' was not provided in the input data."
        ],
        "warnings": [
          "The tag 'optional_field' was provided but not used in the template."
        ]
      },
      "created_at": "2022-05-11T10:56:11-07:00",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "enterprise": {
        "id": "1910967",
        "type": "enterprise"
      },
      "source": "api"
    }
  ]
}
Last modified on July 9, 2026