Job Material Bundles

List all Job Material Bundles

Changed on

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_job_materials.

get/jobmaterialbundle.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/jobmaterialbundle.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_job_materials

Response

An array of Job Material Bundles

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-5851-4780-a80a-23f94f95838b",
    "edit_date": "2026-03-01 12:00:00",
    "material_bundle_uuid": "123e4567-c239-420d-9cd8-23f94d3aa3ab",
    "job_uuid": "123e4567-adf9-46e9-9ec6-23f948b6b8db"
  }
]

Changes

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • c847f5f2f8d9Revision changes
    • info

      the security scope read_job_materials was added to the endpoint's security scheme oauth2