---
updatedAt: 2026-07-01T11:37:16.000Z
agentTools:
  projectIndex: https://developer.servicem8.com/llms.txt
---

# Retrieve a Material


			
#### OAuth Scope
This endpoint requires the following OAuth scope **read_inventory**.

			

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ServiceM8 API",
    "description": "Move your app forward with the ServiceM8 API\n\n\n\n## Limits and Throttling\nTo ensure continuous quality of service, API usage can be subject to throttling. The throttle will be applied once an API consumer reaches a certain \nthreshold in terms of a maximum number of requests per minute. Most clients will never hit this threshold, but those that do, will get met by a \nHTTP 429 Too Many Requests response code. \n \nThere is a limit of 180 requests per minute, if you reach this you will receive a HTTP 429 with a text body of \"Number of allowed API requests per minute exceeded\".\nThere is a limit of 20000 requests per day, if you reach this you will receive a HTTP 429 with a text body of \"Number of allowed API requests per day exceeded\".\n\nWe encourage all API developers to anticipate this error, and take appropriate measures like e.g. using a cached value from a previous call, or passing on a message to the end user that gets subjected to this behaviour (if any).\n\nLimits are per Addon per account.\n\n\n## Opening Records in ServiceM8\nWhen you need to send a staff member from an external app to a ServiceM8 record in the web app, build the URL using the record UUID on the primary app domain:\n\n* Job: `https://go.servicem8.com/OpenJob/{job_uuid}`\n* Client: `https://go.servicem8.com/OpenClient/{company_uuid}`\n\nClient records are exposed by the Company endpoint in the REST API, so use the Company record `uuid` as `{company_uuid}`. These URLs are web app links, not REST API endpoints, and do not use API authentication. Users who are not signed in are redirected through login and then back to the requested record. The signed-in staff member must have access to the record and the relevant ServiceM8 menu permission.\n",
    "termsOfService": "https://www.servicem8.com/terms-of-service",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.servicem8.com/api_1.0"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "paths": {
    "/material/{uuid}.json": {
      "get": {
        "tags": [
          "Materials"
        ],
        "operationId": "getMaterials",
        "summary": "Retrieve a Material",
        "description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_inventory**.\n\n\t\t\t",
        "security": [
          {
            "apiKey": []
          },
          {
            "oauth2": [
              "read_inventory"
            ]
          }
        ],
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "UUID of the Material",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Material record retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Material"
                },
                "examples": {
                  "success": {
                    "value": {
                      "name": "string",
                      "item_number": "string",
                      "price": "string",
                      "cost": "string",
                      "quantity_in_stock": 0,
                      "price_includes_taxes": 0,
                      "barcode": "string",
                      "item_is_inventoried": 0,
                      "uuid": "123e4567-1563-4ddd-a15d-a24af9f67199",
                      "active": 1,
                      "edit_date": "2025-01-01 12:00:00",
                      "item_description": "string",
                      "use_description_for_invoicing": "string",
                      "tax_rate_uuid": "123e4567-0067-483c-b6aa-7795438c5503"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - The request is malformed or contains invalid parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "badRequest": {
                    "value": {
                      "errorCode": 1000,
                      "message": "An error occurred completing your request"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Authentication credentials are missing or invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationError"
                },
                "examples": {
                  "unauthorized": {
                    "value": {
                      "errorCode": 401,
                      "message": "Authentication failed. Please check your API key or OAuth token."
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - You don't have permission to access this resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenError"
                },
                "examples": {
                  "forbidden": {
                    "value": {
                      "errorCode": 403,
                      "message": "Access forbidden. You don't have permission to access this resource."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found - The requested record does not exist or has been deleted",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundError"
                },
                "examples": {
                  "notFound": {
                    "value": {
                      "errorCode": 404,
                      "message": "Resource not found. The requested record does not exist or has been deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests - You have exceeded the rate limit",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateLimitError"
                },
                "examples": {
                  "rateLimitMinute": {
                    "value": {
                      "errorCode": 429,
                      "message": "Number of allowed API requests per minute exceeded"
                    }
                  },
                  "rateLimitDay": {
                    "value": {
                      "errorCode": 429,
                      "message": "Number of allowed API requests per day exceeded"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error - An unexpected error occurred on the server",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "serverError": {
                    "value": {
                      "errorCode": 500,
                      "message": "An unexpected error occurred. Please try again later."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "X-Api-Key",
        "in": "header"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.servicem8.com/oauth/authorize",
            "tokenUrl": "https://api.servicem8.com/oauth/access_token",
            "scopes": {
              "staff_locations": "Access to real-time GPS information about staff",
              "staff_activity": "Access to clock on, lunch break and clock off information about staff",
              "publish_sms": "Access to send SMS messages to customers and/or staff on your behalf. Note sending SMS messages will incur account charges.",
              "publish_email": "Access to send Email messages to customers and/or staff on your behalf",
              "vendor": "Access to basic account information",
              "vendor_logo": "Access to account logo",
              "vendor_email": "Access to account holder email address",
              "read_locations": "Read-only access to Location Endpoint",
              "manage_locations": "Full access to Location Endpoint",
              "read_staff": "Read-only access to Staff Endpoint",
              "manage_staff": "Full access to Staff Endpoint",
              "read_customers": "Read-only access to Company Endpoint",
              "manage_customers": "Full access to Company Endpoint",
              "read_customer_contacts": "Read-only access to CompanyContact Endpoint",
              "manage_customer_contacts": "Full access to CompanyContact Endpoint",
              "read_jobs": "Read-only access to Job and Badge endpoints; includes read_badges",
              "manage_jobs": "Full access to Job Endpoint",
              "create_jobs": "Ability to create jobs on behalf of account. Note creating jobs may incur account charges.",
              "read_job_contacts": "Read-only access to JobContact Endpoint",
              "manage_job_contacts": "Full access to JobContact Endpoint",
              "read_job_materials": "Read-only access to JobMaterials Endpoint",
              "manage_job_materials": "Full access to JobMaterials Endpoint",
              "read_job_categories": "Read-only access to Categories Endpoint",
              "manage_job_categories": "Full access to Categories Endpoint",
              "read_job_queues": "Read-only access to Job Queues Endpoint",
              "manage_job_queues": "Full access to Job Queues Endpoint",
              "read_tasks": "Read-only access to Tasks Endpoint",
              "manage_tasks": "Full access to Tasks Endpoint",
              "read_schedule": "Read-only access to JobActivity Endpoint",
              "manage_schedule": "Full access to JobActivity Endpoint",
              "read_inventory": "Read-only access to Materials Endpoint",
              "manage_inventory": "Full access to Materials Endpoint",
              "read_job_notes": "Read-only access to job notes",
              "publish_job_notes": "Ability to add new job notes",
              "read_job_photos": "Read-only access to job photos",
              "publish_job_photos": "Ability to add new job photos",
              "read_attachments": "Read-only access to Attachments Endpoint",
              "manage_attachments": "Full access to Attachments Endpoint",
              "read_inbox": "Read-only access to inbox messages",
              "read_messages": "Read-only access to staff messages",
              "manage_notifications": "Ability to read notifications and mark as read",
              "read_templates": "Read-only access to email, sms and document templates",
              "manage_templates": "Full-access to email, sms and document templates; includes read_templates",
              "read_badges": "Read-only access to job badges; also granted by read_jobs",
              "manage_badges": "Full-access to read/create/modify job badges; includes read_badges",
              "read_assets": "Read-only access to Assets Endpoint",
              "manage_assets": "Full access to Assets Endpoint",
              "read_knowledge_base": "Read-only access to Knowledge Base Endpoint",
              "manage_knowledge_base": "Full access to Knowledge Base Endpoint",
              "publish_diary_items": "Create immutable Add-on Job Diary items",
              "read_email": "Read job email history",
              "read_sms": "Read job SMS history",
              "create_notifications": "Create staff notifications",
              "read_service_templates": "Read access to ServiceTemplates",
              "manage_service_templates": "Full access to manage ServiceTemplates",
              "read_job_admin_activity": "Read-only access to job administration time records"
            }
          }
        }
      }
    },
    "schemas": {
      "AuthenticationError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 401
          },
          "message": {
            "type": "string",
            "example": "Authentication failed. Please check your API key or OAuth token."
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 1000
          },
          "message": {
            "type": "string",
            "example": "An error occurred completing your request"
          }
        }
      },
      "ForbiddenError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 403
          },
          "message": {
            "type": "string",
            "example": "Access forbidden. You don't have permission to access this resource."
          }
        }
      },
      "Material": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the material, product or labour rate. The maximum length varies based on accounting package integration 30-100 characters for standard mode, up to 2000 characters for description billing mode. Required field that identifies the material in inventory lists, job forms, and invoices.",
            "type": "string"
          },
          "item_number": {
            "description": "Unique identifier code for the material. max length. Must be unique within an account.",
            "type": "string",
            "maxLength": 30
          },
          "price": {
            "description": "The selling price of the material. May include or exclude tax based on the price_includes_taxes field. Used as the default price when adding this material to jobs and generating invoices.",
            "type": "string"
          },
          "cost": {
            "description": "The purchase cost of the material. May include or exclude tax depending on the price_includes_taxes setting. Used for profit calculations and reporting. This field may be hidden from users without appropriate permissions.",
            "type": "string"
          },
          "quantity_in_stock": {
            "description": "The current inventory quantity of this material available in stock. Stored as a numeric value with decimal support. Updated automatically when materials are used in jobs or when inventory is manually adjusted. Only tracked if item_is_inventoried is enabled.",
            "type": "number"
          },
          "price_includes_taxes": {
            "description": "Boolean flag indicating whether the price and cost values include tax (1/true) or exclude tax (0/false). Controls tax calculations when determining final pricing. New materials inherit this setting from the account's default tax display preference. Valid values are [0,1]",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "barcode": {
            "description": "The barcode identifier for the material.  Can store UPC, EAN, or other barcode formats. Used for inventory scanning and quick material lookup in the mobile app.",
            "type": "string"
          },
          "item_is_inventoried": {
            "description": "Boolean flag indicating whether inventory tracking is enabled for this material (1/true) or disabled (0/false). When enabled, the quantity_in_stock is tracked and updated automatically when the material is used in jobs. Only physical products typically have this enabled. Valid values are [0,1]",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "uuid": {
            "format": "uuid",
            "description": "Unique identifier for this record",
            "example": "123e4567-1563-4ddd-a15d-a24af9f67199",
            "type": "string"
          },
          "active": {
            "enum": [
              0,
              1
            ],
            "type": "integer",
            "default": 1,
            "description": "Record active/deleted flag. Valid values are [0,1]"
          },
          "edit_date": {
            "readOnly": true,
            "example": "2025-01-01 12:00:00",
            "description": "Timestamp at which record was last modified"
          },
          "item_description": {
            "type": "string"
          },
          "use_description_for_invoicing": {
            "type": "string"
          },
          "tax_rate_uuid": {
            "format": "uuid",
            "example": "123e4567-0067-483c-b6aa-7795438c5503",
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      },
      "NotFoundError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 404
          },
          "message": {
            "type": "string",
            "example": "Resource not found. The requested record does not exist or has been deleted."
          }
        }
      },
      "RateLimitError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 429
          },
          "message": {
            "type": "string",
            "example": "Number of allowed API requests per minute exceeded"
          }
        }
      }
    }
  },
  "x-speakeasy-retries": {
    "strategy": "backoff",
    "backoff": {
      "initialInterval": 500,
      "maxInterval": 60000,
      "maxElapsedTime": 3600000,
      "exponent": 1.5
    },
    "statusCodes": [
      "5XX",
      "429"
    ],
    "retryConnectionErrors": true
  },
  "tags": [
    {
      "name": "Materials",
      "description": "Operations related to Materials"
    }
  ]
}
```