API ReferenceMaterials

Get Material

Returns a single material by ID with full details.

Requires scope: materials:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Material ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the material.
namestring
Display name of the material.
activeboolean
Whether the material is currently active in the catalog.
serializedboolean
Whether individual units of this material are tracked by serial number.
categorieslist of strings
List of category names assigned to this material.
tagslist of strings
List of tag names assigned to this material.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
itemNumberstring

Item/SKU number for the material.

brandstring
Brand of the material.
manufacturerstring
Manufacturer of the material.
descriptionstring
Detailed description of the material.
materialTypeenum
Classification of the material.
measurementUnitstring

Unit of measurement (e.g. EA, FT, LB).

costForBusinessdouble

Internal business cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.

costForClientdouble

Client-facing cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error