Sign in
Job Material Bundles

Retrieve a Job Material Bundle

OAuth Scope

This endpoint requires the following OAuth scope read_job_materials.

get/jobmaterialbundle/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Job Material Bundle

Response

Job Material Bundle record retrieved successfully

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

item_numberstring

Unique identifier for the material bundle within the job. Displayed on the Quote/Invoice in the same way as for JobMaterials.

namestring

Descriptive name of the job material bundle. Displayed on the Quote/Invoice in the same way as for JobMaterials.

quantitystring

The quantity shown for the bundle line item on the invoice. Must be greater than zero. The quantity of each JobMaterial within the bundle is determined by dividing by this value.

sort_orderinteger

Defines the display order of the JobMaterialBundle relative to other JobMaterials and JobMaterialBundles on the Job. Lower values are displayed first.

material_bundle_uuidstring uuid

UUID of the MaterialBundle which this JobMaterialBundle was originally created from.

job_uuidstring uuid

UUID of the job that this material bundle is associated with. Links the bundle to a specific job record.

Example response

{
  "uuid": "123e4567-7ce3-4a7e-b80c-231fe218d73b",
  "edit_date": "2025-08-01 12:00:00",
  "material_bundle_uuid": "123e4567-f98b-4da5-a6f0-231fef0058fb",
  "job_uuid": "123e4567-33ae-471a-96c2-231fe64b12db"
}

Changes