Bundles

Retrieve a Bundle

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_inventory.

get/materialbundle/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/materialbundle/{uuid}.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_inventory

Path parameters

uuidstring uuid required

UUID of the Bundle

Response

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 required

Unique identifier for this bundle. Must be 30 characters or less and unique across both Materials and Bundles. Used when adding bundles to jobs.

namestring

The display name of the bundle. Used for identification in the system and shows on documents when the bundle is added to a job.

Example response

{
  "uuid": "123e4567-b6d8-4938-9093-23f94402363b",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

  • 3999cf7e5b40Revision changes
    • info

      added the optional property // to the response with the status

  • 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

    • info

      added the non-success response with the status