Digital Permit Book
Website

Retrieve maintenance record details

GET/app/v1/maintenance/{id}/

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Path parameters

idintegerrequired

A unique integer value identifying this maintenance.

Query parameters

end_datestring

Only records on or before this date (YYYY-MM-DD).

start_datestring

Only records on or after this date (YYYY-MM-DD).

statusstring

Record status: New, Open, Urgent or Closed.

typestring

Filter by equipment type: Vehicle or Trailer.

unit_nostring

Filter by equipment unit number. Comma separated for more than one (e.g. 101,102).

vendorstring

Filter by vendor name (exact, case-insensitive).

Response

200The record
idinteger
record_nointeger

Human-facing record number, unique inside the company.

unitobject
Show fields
idinteger
unit_nostring
typeenum

One of: Vehicle Trailer

datestring (date)
descriptionstring
amountstring (decimal)
odometerinteger
statusenum

One of: Open Urgent New Closed

typesarray of object
Show fields
idinteger
namestring
vendorobject
Show fields
idinteger
namestring
addressstring
citystring
stateobject
zipstring
phonestring
emailstring (email)
created_atstring (date-time)
updated_atstring (date-time)
uploaded_by_driverobject
Show fields
idinteger
namestring
sourceenum

'manual' when entered by hand, 'bot' when read off a receipt by AI.

One of: manual bot

line_itemsarray of object
Show fields
idinteger
item_typeenum

One of: LABOR PART FEE TAX DISCOUNT OTHER

maintenance_categoryenum

One of: Air System Brake System Cooling System Drivetrain Electrical System Engine & Powertrain Exhaust System Fuel System HVAC & Cab Safety & DOT Compliance Suspension & Steering Tire Service Misc Charges Other

descriptionstring
line_datestring (date)
quantitystring (decimal)
ratestring (decimal)
amountstring (decimal)
documentsarray of object
Show fields
idinteger
documentstring (uri)
datestring (date)
descriptionstring
created_atstring (date-time)
updated_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)