API ReferenceEquipment

Get Equipment

Returns a single piece of equipment by ID.

Requires scope: equipment:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Equipment ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the equipment.
namestring
Display name of the equipment.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
itemNumberstringOptional
Item number or internal reference.
descriptionstringOptional

Free-form description.

brandstringOptional
Brand name.
modelstringOptional
Model designation.
manufacturerstringOptional
Manufacturer name.
equipmentTypeobjectOptional
The equipment type this belongs to.
measurementUnitstringOptional
Name of the unit of measure.
costForBusinessdoubleOptional
Cost to your business.
costForClientdoubleOptional
Price charged to the client.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error