List Work Orders

GET 
https://secure.fleetio.com/api/v1/work_orders

deprecated

This endpoint is deprecated and will be removed in a future version. Please use the new v2 endpoint instead.

Returns a list of Work Orders belonging to your account.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
numberstringrequired
The unique number of this Work Order.
completed_atdate-timenullablerequired
The date and time at which the Work Order was completed.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullablerequired
A description of this Work Order.
ending_meter_same_as_startbooleanrequired
Indicates whether or not the ending meter is the same as the starting meter.
duration_in_secondsintegernullablerequired
The number of seconds elapsed between beginning this Work Order and completing it.
invoice_numberstringnullablerequired
The number of the Invoice associated with this Work Order.
created_by_idintegerrequired
The id of the User who created this Work Order.
statestringrequired
Indicates whether this Work Order is currently active or has already been completed.
Possible values: [active, completed]
issued_atdate-timerequired
The date and time at which the Work Order was issued.
Example: 2023-03-14T13:46:27-06:00
issued_by_idNullableId (integer)nullablerequired
Possible values: >= 1
issued_by_namestringnullablerequired
The name of the Contact associated with the User who issued this Work Order.
contact_idNullableId (integer)nullablerequired
Possible values: >= 1
contact_namestringnullablerequired
The name of the Contact currently assigned to this Work Order.
purchase_order_numberstringnullablerequired
The number of any Purchase Order associated with this Work Order.
started_atdate-timenullablerequired
The date and time at which the Work Order was started.
Example: 2023-03-14T13:46:27-06:00
expected_completed_atdate-timenullable
The date and time at which the Work Order is expected to be completed.
Example: 2023-03-14T13:46:27-06:00
contact_image_urlstringnullable
The URL of the image associated with the Contact currently assigned to this Work Order.
work_order_sub_line_items object[]required
Array [
anyOf
Work Order Sub Line Item
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullable
The description of the sub line item.
item_idId (integer)
Possible values: >= 1
item_typestring
Possible values: [Contact]
work_order_line_item_idNullableId (integer)nullable
Possible values: >= 1
quantityfloat
The quantity of this sub line item.
part_location_detail_idNullableId (integer)nullable
Possible values: >= 1
positionintegernullable
The position of this sub line item in a list of sub line items.
Possible values: >= 0
item_namestring
The name of this sub line item.
unit_costfloat
The unit cost of this sub line item.
contact objectnullable
A Contact
idinteger
created_atdate-time
updated_atdate-time
emailstringnullable
The Contact's email address.
namestringnullable
The Contact's full name.
first_namestringnullable
The Contact's first name.
middle_namestringnullable
The Contact's middle name.
last_namestringnullable
The Contact's last name.
images_countinteger
The number of images associated with this Contact.
Possible values: >= 0
documents_countinteger
The number of documents associated with this Contact.
Possible values: >= 0
comments_countinteger
The number of comments associated with this Contact.
Possible values: >= 0
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_namestringnullable
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchystringnullable
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
Example: Group 1|Group 2|Group 3
technicianbooleannullable
Whether or not the Contact is a Technician.
vehicle_operatorbooleannullable
Whether or not the Contact is a Vehicle Operator.
employeebooleannullable
Whether or not the Contact is an Employee.
birth_datedatenullable
The Contact's birth date.
Example: 2023-03-14
street_addressstringnullable
The Contact's street address.
Example: 123 Main St
street_address_line_2stringnullable
The Contact's street address line 2.
Example: Apt 1
citystringnullable
The Contact's city.
regionstringnullable
The Contact's region, state, or province.
postal_codestringnullable
The Contact's postal code, zip code, or equivalent.
countrystringnullable
The Contact's country.
employee_numberstringnullable
The Contact's employee number.
job_titlestringnullable
The Contact's job title.
Possible values: <= 255 characters
license_classstringnullable
The Contact's driver's license class.
license_numberstringnullable
The Contact's driver's license number.
license_statestringnullable
The locality which issued the Contact's license.
license_expirationdatenullable
The Contact's driver's license expiration date.
Example: 2023-03-14
home_phone_numberstringnullable
The Contact's home phone number.
mobile_phone_numberstringnullable
The Contact's mobile phone number.
work_phone_numberstringnullable
The Contact's work phone number.
other_phone_numberstringnullable
Any other phone number for this Contact.
start_datedatenullable
When the Contact started working for the company, if applicable.
leave_datedatenullable
When the Contact left or will leave the company, if applicable.
hourly_labor_ratefloatnullable
The Contact's hourly rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
attachment_permissions objectnullable
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_urlstringnullable
The URL of the Contact's default image/profile photo, if any.
userobjectnullable
If the Contact is a Fleetio User, those details will be included here.
account_membership_idNullableId (integer)nullable
Possible values: >= 1
last_api_requestdate-timenullable
The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.
last_web_accessdate-timenullable
The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.
last_mobile_app_accessdate-timenullable
The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.
labor_time_entries object[]
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_idId (integer)
Possible values: >= 1
contact_idId (integer)
Possible values: >= 1
duration_in_secondsinteger
ended_atdate-timenullable
Example: 2023-03-14T13:46:27-06:00
laborable_idId (integer)
Possible values: >= 1
laborable_typestring
Possible values: [WorkOrderSubLineItem]
started_atdate-time
Example: 2023-03-14T13:46:27-06:00
data object
clock_in_latitudefloat
clock_in_longitudefloat
clock_out_latitudefloat
clock_out_longitudefloat
activeboolean
Indicates whether this Labor Time Entry is active.
]
Work Order Sub Line Item
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullable
The description of this sub line item.
item_idinteger
The ID of the Part associated with this sub line item.
item_typestring
Possible values: [Part]
work_order_line_item_idNullableId (integer)nullable
Possible values: >= 1
quantityfloat
The quantity of this sub line item.
part_location_detail_idNullableId (integer)nullable
Possible values: >= 1
positionintegernullable
The position of this sub line item in a list of sub line items.
item_namestring
The name of this sub line item.
unit_costfloatnullable
The unit cost of this sub line item.
part objectnullable
A Part
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullablerequired
A description of this Part.
manufacturer_part_numberstringnullablerequired
The part number from this Part's manufacturer.
measurement_unit_idNullableId (integer)nullablerequired
Possible values: >= 1
numberstringrequired
The part number being used for this Part within Fleetio.
part_category_idNullableId (integer)nullablerequired
Possible values: >= 1
part_manufacturer_idNullableId (integer)nullablerequired
Possible values: >= 1
upcstringnullablerequired
The Universal Product Code for this Part.
total_quantityfloatrequired
The total quantity on hand for this Part.
Possible values: >= 0
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
inventory_itembooleanrequired
Indicates whether or not this Part is an inventory item.
part_category objectnullable
idId (integer)
Possible values: >= 1
tire_categoryboolean
Indicates whether part is a tire or not
part_category_namestringnullablerequired
The name of the part category associated with this Part.
part_manufacturer_namestringnullablerequired
The name of the Part's manufacturer.
measurement_unit_namestringnullablerequired
The measurement unit used by this Part.
unit_costfloatnullablerequired
The unit cost for this Part.
average_unit_costfloatnullable
The average unit cost for this Part. FIFO/LIFO accounts only.
part_locations object[]required
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
activeboolean
Whether this Part Location is active.
aislestringnullable
The aisle in which the Part is located.
available_quantityfloat
How many of this Part are available at this Part Location.
binstringnullable
The bin in which the Part is located.
inventory_sets_countinteger
The number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only.
has_been_used_in_work_ordersbooleannullable
Whether this Part has been used in any Work Orders. FIFO/LIFO accounts only.
namestring
Alias of part_location_name.
part_location_namestring
The name of the Part Location for this Part.
part_location_idinteger
The ID of the Part Location for this Part.
quantity_allocated_to_work_ordersfloatnullable
How many of these Parts are currently allocated to Work Orders.
quantity_on_orderfloatnullable
How many of this Part are currently on order, if any.
reorder_pointfloat
The lower-threshold quantity at which this Part should be reordered.
reorder_point_enabledboolean
Whether this Part will be reordered at the reorder point.
rowstringnullable
The row in which the Part is located.
track_inventoryboolean
Indicates whether inventory is tracked for this Part at this location.
available_quantity_updated_atdate-timenullable
Example: 2023-03-14T13:46:27-06:00
part_location_archived_atdate-timenullable
The date and time at which the Part Location was archived, if applicable.
]
default_image_urlstringnullablerequired
default_image_url_mediumstringnullablerequired
default_image_url_smallstringnullablerequired
default_image_url_largestringnullablerequired
archived_atdate-timenullablerequired
The date and time at which this Part was archived.
Example: 2023-03-14T13:46:27-06:00
attachment_permissions objectnullablerequired
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
has_active_inventory_setsboolean
Indicates whether this Part has any active Inventory Sets. FIFO/LIFO accounts only.
tire_config object
aspect_ratiofloat
Aspect ratio of tire.
rim_diameterfloat
Rim diameter of tire.
load_indexfloat
Load index of tire.
metric_typestring
Metric type of tire.
Possible values: [EU, P, HL, T, LT, C, ST]
widthfloat
Width of tire.
constructionstring
Construction type of tire.
Possible values: [B, R, D]
speed_ratingstring
Speed rating of tire.
Possible values: [A1, A2, A3, A4, A5, A6, A7, A8, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, Y]
factory_tread_depthfloat
factory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depthfloat
minimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancyinteger
life_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
comments object[]required
A list of the comments made on this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
commentable_typeCommentableType (string)required
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
commentable_idId (integer)required
Possible values: >= 1
user_idId (integer)required
Possible values: >= 1
titlestringdeprecated
The title of the Comment.
commentstringrequired
The content of the Comment message body.
user_full_namestringrequired
The full name of the User who created the Comment.
user_image_urlstringnullablerequired
The image url for the User who created the Comment.
rich_contentobjectnullablerequired
html_contentstringnullablerequired
The comment message body rendered as HTML.
with_mentionsbooleanrequired
Indicates if the message body contains @mentions.
]
comments_countintegerrequired
The number of comments made on this record.
Possible values: >= 0
documents object[]required
A list of the documents attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringrequired
The name of the document.
descriptionstringrequired
The description of the document.
documentable_idId (integer)required
Possible values: >= 1
documentable_typeDocumentableType (string)required
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry, Vehicle]
file_namestringrequired
The name of the file.
file_mime_typestringrequired
The MIME type of the file.
file_sizenumberrequired
The size of the file in bytes.
file_urlstringrequired
The URL to access the file.
full_file_urlstringrequired
The full URL to access the file, including any necessary authentication or parameters.
]
documents_countintegerrequired
The number of documents attached to this record.
Possible values: >= 0
images object[]required
A list of the images attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
imageable_idId (integer)
Possible values: >= 1
imageable_typeImageableType (string)
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_namestring
The name of the image file.
file_mime_typeImage MIME Type (string)
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_sizenumber
The size of the image file in bytes.
file_urlstring
The URL to access the image file.
full_urlstring
The full URL to access the image file, including any necessary authentication or parameters.
]
images_countintegerrequired
The number of images attached to this record.
Possible values: >= 0
]
scheduled_atdate-timenullablerequired
The date and time at which the Work Order was scheduled.
Example: 2023-03-14T13:46:27-06:00
vehicle_idId (integer)required
Possible values: >= 1
vehicle_namestringrequired
The name of the Vehicle associated with this Work Order.
vendor_idNullableId (integer)nullablerequired
Possible values: >= 1
vendor_namestringnullablerequired
The name of the Vendor associated with this Work Order.
work_order_status_idId (integer)required
Possible values: >= 1
work_order_status_namestringrequired
The name of the Work Order Status associated with this Work Order.
work_order_status_colorstringnullablerequired
The color of the Work Order Status seen in the UI.
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
work_order_line_items object[]required
Array [
idinteger
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullablerequired
A description of this Work Order Line Item.
titlestring
The title of this Work Order Line Item.
item_idintegerrequired
The ID of the item associated with this Work Order Line Item.
item_typestringrequired
The type of item associated with this Work Order Line Item.
Possible values: [Issue, ServiceTask]
work_order_line_item_idintegernullablerequired
item_namestringrequired
The name of the item associated with this Work Order Line Item.
positionintegernullablerequired
The position of this Work Order Line Item in a list of Work Order Line Items.
issues object[]required
Any Issues associated with this Work Order Line Item.
Array [
idinteger
The ID of the Issue.
namestring
The name of the Issue.
]
vmrs_reason_for_repair objectnullablerequired
account_idinteger
aliasstringnullable
codestringnullable
enabledboolean
idinteger
namestring
repair_typestringnullable
standardboolean
standard_namestringnullable
typestring
vmrs_standard_reason_for_repairobjectnullable
vmrs_system_group objectnullablerequired
account_idnumbernullable
assembly_codestringnullable
assembly_namestringnullable
code_typestring
Possible values: [system_group, system, assembly, component]
component_codestringnullable
component_namestringnullable
enabledboolean
idinteger
permissions objectnullable
destroyboolean
standardboolean
system_codestringnullable
system_groupstringnullable
system_group_codestringnullable
system_namestringnullable
typestring
vmrs_standard_system_assembly_componentobjectnullable
vmrs_system objectnullablerequired
account_idnumbernullable
assembly_codestringnullable
assembly_namestringnullable
code_typestring
Possible values: [system_group, system, assembly, component]
component_codestringnullable
component_namestringnullable
enabledboolean
idinteger
permissions objectnullable
destroyboolean
standardboolean
system_codestringnullable
system_groupstringnullable
system_group_codestringnullable
system_namestringnullable
typestring
vmrs_standard_system_assembly_componentobjectnullable
vmrs_assembly objectnullablerequired
account_idnumbernullable
assembly_codestringnullable
assembly_namestringnullable
code_typestring
Possible values: [system_group, system, assembly, component]
component_codestringnullable
component_namestringnullable
enabledboolean
idinteger
permissions objectnullable
destroyboolean
standardboolean
system_codestringnullable
system_groupstringnullable
system_group_codestringnullable
system_namestringnullable
typestring
vmrs_standard_system_assembly_componentobjectnullable
vmrs_component objectnullablerequired
account_idnumbernullable
assembly_codestringnullable
assembly_namestringnullable
code_typestring
Possible values: [system_group, system, assembly, component]
component_codestringnullable
component_namestringnullable
enabledboolean
idinteger
permissions objectnullable
destroyboolean
standardboolean
system_codestringnullable
system_groupstringnullable
system_group_codestringnullable
system_namestringnullable
typestring
vmrs_standard_system_assembly_componentobjectnullable
work_order_sub_line_items object[]required
Array [
anyOf
Work Order Sub Line Item
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullable
The description of the sub line item.
item_idId (integer)
Possible values: >= 1
item_typestring
Possible values: [Contact]
work_order_line_item_idNullableId (integer)nullable
Possible values: >= 1
quantityfloat
The quantity of this sub line item.
part_location_detail_idNullableId (integer)nullable
Possible values: >= 1
positionintegernullable
The position of this sub line item in a list of sub line items.
Possible values: >= 0
item_namestring
The name of this sub line item.
unit_costfloat
The unit cost of this sub line item.
contact objectnullable
A Contact
idinteger
created_atdate-time
updated_atdate-time
emailstringnullable
The Contact's email address.
namestringnullable
The Contact's full name.
first_namestringnullable
The Contact's first name.
middle_namestringnullable
The Contact's middle name.
last_namestringnullable
The Contact's last name.
images_countinteger
The number of images associated with this Contact.
Possible values: >= 0
documents_countinteger
The number of documents associated with this Contact.
Possible values: >= 0
comments_countinteger
The number of comments associated with this Contact.
Possible values: >= 0
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_namestringnullable
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchystringnullable
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
Example: Group 1|Group 2|Group 3
technicianbooleannullable
Whether or not the Contact is a Technician.
vehicle_operatorbooleannullable
Whether or not the Contact is a Vehicle Operator.
employeebooleannullable
Whether or not the Contact is an Employee.
birth_datedatenullable
The Contact's birth date.
Example: 2023-03-14
street_addressstringnullable
The Contact's street address.
Example: 123 Main St
street_address_line_2stringnullable
The Contact's street address line 2.
Example: Apt 1
citystringnullable
The Contact's city.
regionstringnullable
The Contact's region, state, or province.
postal_codestringnullable
The Contact's postal code, zip code, or equivalent.
countrystringnullable
The Contact's country.
employee_numberstringnullable
The Contact's employee number.
job_titlestringnullable
The Contact's job title.
Possible values: <= 255 characters
license_classstringnullable
The Contact's driver's license class.
license_numberstringnullable
The Contact's driver's license number.
license_statestringnullable
The locality which issued the Contact's license.
license_expirationdatenullable
The Contact's driver's license expiration date.
Example: 2023-03-14
home_phone_numberstringnullable
The Contact's home phone number.
mobile_phone_numberstringnullable
The Contact's mobile phone number.
work_phone_numberstringnullable
The Contact's work phone number.
other_phone_numberstringnullable
Any other phone number for this Contact.
start_datedatenullable
When the Contact started working for the company, if applicable.
leave_datedatenullable
When the Contact left or will leave the company, if applicable.
hourly_labor_ratefloatnullable
The Contact's hourly rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
attachment_permissions objectnullable
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_urlstringnullable
The URL of the Contact's default image/profile photo, if any.
userobjectnullable
If the Contact is a Fleetio User, those details will be included here.
account_membership_idNullableId (integer)nullable
Possible values: >= 1
last_api_requestdate-timenullable
The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.
last_web_accessdate-timenullable
The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.
last_mobile_app_accessdate-timenullable
The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.
labor_time_entries object[]
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_idId (integer)
Possible values: >= 1
contact_idId (integer)
Possible values: >= 1
duration_in_secondsinteger
ended_atdate-timenullable
Example: 2023-03-14T13:46:27-06:00
laborable_idId (integer)
Possible values: >= 1
laborable_typestring
Possible values: [WorkOrderSubLineItem]
started_atdate-time
Example: 2023-03-14T13:46:27-06:00
data object
clock_in_latitudefloat
clock_in_longitudefloat
clock_out_latitudefloat
clock_out_longitudefloat
activeboolean
Indicates whether this Labor Time Entry is active.
]
Work Order Sub Line Item
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullable
The description of this sub line item.
item_idinteger
The ID of the Part associated with this sub line item.
item_typestring
Possible values: [Part]
work_order_line_item_idNullableId (integer)nullable
Possible values: >= 1
quantityfloat
The quantity of this sub line item.
part_location_detail_idNullableId (integer)nullable
Possible values: >= 1
positionintegernullable
The position of this sub line item in a list of sub line items.
item_namestring
The name of this sub line item.
unit_costfloatnullable
The unit cost of this sub line item.
part objectnullable
A Part
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
descriptionstringnullablerequired
A description of this Part.
manufacturer_part_numberstringnullablerequired
The part number from this Part's manufacturer.
measurement_unit_idNullableId (integer)nullablerequired
Possible values: >= 1
numberstringrequired
The part number being used for this Part within Fleetio.
part_category_idNullableId (integer)nullablerequired
Possible values: >= 1
part_manufacturer_idNullableId (integer)nullablerequired
Possible values: >= 1
upcstringnullablerequired
The Universal Product Code for this Part.
total_quantityfloatrequired
The total quantity on hand for this Part.
Possible values: >= 0
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
inventory_itembooleanrequired
Indicates whether or not this Part is an inventory item.
part_category objectnullable
idId (integer)
Possible values: >= 1
tire_categoryboolean
Indicates whether part is a tire or not
part_category_namestringnullablerequired
The name of the part category associated with this Part.
part_manufacturer_namestringnullablerequired
The name of the Part's manufacturer.
measurement_unit_namestringnullablerequired
The measurement unit used by this Part.
unit_costfloatnullablerequired
The unit cost for this Part.
average_unit_costfloatnullable
The average unit cost for this Part. FIFO/LIFO accounts only.
part_locations object[]required
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
activeboolean
Whether this Part Location is active.
aislestringnullable
The aisle in which the Part is located.
available_quantityfloat
How many of this Part are available at this Part Location.
binstringnullable
The bin in which the Part is located.
inventory_sets_countinteger
The number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only.
has_been_used_in_work_ordersbooleannullable
Whether this Part has been used in any Work Orders. FIFO/LIFO accounts only.
namestring
Alias of part_location_name.
part_location_namestring
The name of the Part Location for this Part.
part_location_idinteger
The ID of the Part Location for this Part.
quantity_allocated_to_work_ordersfloatnullable
How many of these Parts are currently allocated to Work Orders.
quantity_on_orderfloatnullable
How many of this Part are currently on order, if any.
reorder_pointfloat
The lower-threshold quantity at which this Part should be reordered.
reorder_point_enabledboolean
Whether this Part will be reordered at the reorder point.
rowstringnullable
The row in which the Part is located.
track_inventoryboolean
Indicates whether inventory is tracked for this Part at this location.
available_quantity_updated_atdate-timenullable
Example: 2023-03-14T13:46:27-06:00
part_location_archived_atdate-timenullable
The date and time at which the Part Location was archived, if applicable.
]
default_image_urlstringnullablerequired
default_image_url_mediumstringnullablerequired
default_image_url_smallstringnullablerequired
default_image_url_largestringnullablerequired
archived_atdate-timenullablerequired
The date and time at which this Part was archived.
Example: 2023-03-14T13:46:27-06:00
attachment_permissions objectnullablerequired
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
has_active_inventory_setsboolean
Indicates whether this Part has any active Inventory Sets. FIFO/LIFO accounts only.
tire_config object
aspect_ratiofloat
Aspect ratio of tire.
rim_diameterfloat
Rim diameter of tire.
load_indexfloat
Load index of tire.
metric_typestring
Metric type of tire.
Possible values: [EU, P, HL, T, LT, C, ST]
widthfloat
Width of tire.
constructionstring
Construction type of tire.
Possible values: [B, R, D]
speed_ratingstring
Speed rating of tire.
Possible values: [A1, A2, A3, A4, A5, A6, A7, A8, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, Y]
factory_tread_depthfloat
factory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depthfloat
minimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancyinteger
life_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
comments object[]required
A list of the comments made on this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
commentable_typeCommentableType (string)required
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
commentable_idId (integer)required
Possible values: >= 1
user_idId (integer)required
Possible values: >= 1
titlestringdeprecated
The title of the Comment.
commentstringrequired
The content of the Comment message body.
user_full_namestringrequired
The full name of the User who created the Comment.
user_image_urlstringnullablerequired
The image url for the User who created the Comment.
rich_contentobjectnullablerequired
html_contentstringnullablerequired
The comment message body rendered as HTML.
with_mentionsbooleanrequired
Indicates if the message body contains @mentions.
]
comments_countintegerrequired
The number of comments made on this record.
Possible values: >= 0
documents object[]required
A list of the documents attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringrequired
The name of the document.
descriptionstringrequired
The description of the document.
documentable_idId (integer)required
Possible values: >= 1
documentable_typeDocumentableType (string)required
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry, Vehicle]
file_namestringrequired
The name of the file.
file_mime_typestringrequired
The MIME type of the file.
file_sizenumberrequired
The size of the file in bytes.
file_urlstringrequired
The URL to access the file.
full_file_urlstringrequired
The full URL to access the file, including any necessary authentication or parameters.
]
documents_countintegerrequired
The number of documents attached to this record.
Possible values: >= 0
images object[]required
A list of the images attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
imageable_idId (integer)
Possible values: >= 1
imageable_typeImageableType (string)
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_namestring
The name of the image file.
file_mime_typeImage MIME Type (string)
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_sizenumber
The size of the image file in bytes.
file_urlstring
The URL to access the image file.
full_urlstring
The full URL to access the image file, including any necessary authentication or parameters.
]
images_countintegerrequired
The number of images attached to this record.
Possible values: >= 0
]
subtotalfloatnullable
The pre-tax subtotal amount.
Example: 1.23
subtotal_centsintegernullable
The pre-tax subtotal amount in cents.
labor_costfloatnullable
The cost of labor units worked.
Example: 1.23
parts_costfloatnullable
The cost of parts.
Example: 1.23
parts_cost_centsintegernullable
The parts cost amount in cents.
labor_cost_centsintegernullable
The cost of labor units worked, in cents.
]
labor_time_entries object[]required
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_idId (integer)
Possible values: >= 1
contact_idId (integer)
Possible values: >= 1
duration_in_secondsinteger
ended_atdate-timenullable
Example: 2023-03-14T13:46:27-06:00
laborable_idId (integer)
Possible values: >= 1
laborable_typestring
Possible values: [WorkOrderSubLineItem]
started_atdate-time
Example: 2023-03-14T13:46:27-06:00
data object
clock_in_latitudefloat
clock_in_longitudefloat
clock_out_latitudefloat
clock_out_longitudefloat
activeboolean
Indicates whether this Labor Time Entry is active.
]
meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
starting_meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
ending_meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
secondary_meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
starting_secondary_meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
ending_secondary_meter_entry objectnullable
A Meter Entry
idinteger
created_atdate-time
updated_atdate-time
auto_voided_atdate-timenullable
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
categorystringnullable
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringnullable
Indicates whether or not this Meter is a secondary Meter.
Possible values: [secondary]
meterable_idNullableId (integer)nullable
Possible values: >= 1
meterable_typestringnullable
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestring
The current value of the meter.
vehicle_idNullableId (integer)nullable
Possible values: >= 1
voidboolean
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullable
Possible values: [GpsMeterEntry]
datedate
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
Example: 2023-03-14
attachment_permissions objectnullable
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
vmrs_repair_priority_class objectnullablerequired
The VMRS Repair Priority Class associated with this Work Order.
idinteger
The ID of the VMRS Repair Priority Class.
codestring
The code of the VMRS Repair Priority Class.
namestring
The name of the VMRS Repair Priority Class.
colorstring
The color of the VMRS Repair Priority Class.
labels object[]required
Array [
idId (integer)
Possible values: >= 1
namestring
]
issues object[]required
Any Issues associated with this Work Order.
Array [
idinteger
The ID of the Issue.
namestring
The name of the Issue.
]
watchers_countinteger
The number of Users watching this Work Order.
is_watchedboolean
Indicates whether the current User is watching this Work Order.
discount_typeDiscountType (string)nullablerequired
The type of discount applied to this record.
Possible values: [fixed, percentage]
Default value: percentage
discount_percentagefloatnullablerequired
The discount percentage. This field should be present when discount_type is set to percentage.
Example: 1.23
discountfloatnullablerequired
The discount amount.
Example: 1.23
parts_subtotalfloatnullablerequired
The total cost of parts for this record.
Example: 1.23
labor_subtotalfloatnullablerequired
The total cost of labor for this record.
Example: 1.23
subtotalfloatnullablerequired
The pre-tax subtotal amount.
Example: 1.23
tax_1_typeTaxType (string)nullablerequired
The type of tax to apply to this record.
Possible values: [fixed, percentage]
Default value: percentage
tax_1_percentagefloatnullablerequired
The primary tax percentage amount. This field should be present when tax_1_type is set to percentage.
Example: 1.23
tax_2_typeTaxType (string)nullablerequired
The type of tax to apply to this record.
Possible values: [fixed, percentage]
Default value: percentage
tax_2_percentagefloatnullablerequired
The secondary tax percentage amount. This field should be present when tax_2_type is set to percentage. Note that this secondary tax must be configured in your Account Settings.
Example: 1.23
tax_1floatnullablerequired
The primary tax amount.
Example: 1.23
tax_2floatnullablerequired
The secondary tax amount. Note that this secondary tax must be configured in your Account Settings.
Example: 1.23
parts_markup_typePartMarkupType (string)
The type of parts markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans
Possible values: [fixed, percentage]
parts_markupfloat
The parts markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans
Example: 1.23
parts_markup_percentagefloat
The parts markup percentage amount. This field should be present when parts_markup_type is set to percentage.
Note that this is a readonly value that will default to 0.0 for non-premium plans
Example: 1.23
labor_markup_typeLaborMarkupType (string)
The type of labor markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans
Possible values: [fixed, percentage]
labor_markupfloat
The labor markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans
Example: 1.23
labor_markup_percentagefloat
The labor markup percentage amount. This field should be present when labor_markup_type is set to percentage.
Note that this is a readonly value that will default to 0.0 for non-premium plans
Example: 1.23
total_amountfloatnullablerequired
The total amount.
Example: 1.23
labor_time_in_secondsintegernullable
The sum, in seconds, of the duration of all labor line items of a completed Work Order.
comments object[]
A list of the comments made on this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
commentable_typeCommentableType (string)required
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
commentable_idId (integer)required
Possible values: >= 1
user_idId (integer)required
Possible values: >= 1
titlestringdeprecated
The title of the Comment.
commentstringrequired
The content of the Comment message body.
user_full_namestringrequired
The full name of the User who created the Comment.
user_image_urlstringnullablerequired
The image url for the User who created the Comment.
rich_contentobjectnullablerequired
html_contentstringnullablerequired
The comment message body rendered as HTML.
with_mentionsbooleanrequired
Indicates if the message body contains @mentions.
]
comments_countinteger
The number of comments made on this record.
Possible values: >= 0
images object[]
A list of the images attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
imageable_idId (integer)
Possible values: >= 1
imageable_typeImageableType (string)
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_namestring
The name of the image file.
file_mime_typeImage MIME Type (string)
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_sizenumber
The size of the image file in bytes.
file_urlstring
The URL to access the image file.
full_urlstring
The full URL to access the image file, including any necessary authentication or parameters.
]
images_countinteger
The number of images attached to this record.
Possible values: >= 0
documents object[]
A list of the documents attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringrequired
The name of the document.
descriptionstringrequired
The description of the document.
documentable_idId (integer)required
Possible values: >= 1
documentable_typeDocumentableType (string)required
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry, Vehicle]
file_namestringrequired
The name of the file.
file_mime_typestringrequired
The MIME type of the file.
file_sizenumberrequired
The size of the file in bytes.
file_urlstringrequired
The URL to access the file.
full_file_urlstringrequired
The full URL to access the file, including any necessary authentication or parameters.
]
documents_countinteger
The number of documents attached to this record.
Possible values: >= 0
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "number": "string",
    "completed_at": "2023-03-14T13:46:27-06:00",
    "description": "string",
    "ending_meter_same_as_start": true,
    "duration_in_seconds": 0,
    "invoice_number": "string",
    "created_by_id": 0,
    "state": "active",
    "issued_at": "2023-03-14T13:46:27-06:00",
    "issued_by_id": 0,
    "issued_by_name": "string",
    "contact_id": 0,
    "contact_name": "string",
    "purchase_order_number": "string",
    "started_at": "2023-03-14T13:46:27-06:00",
    "expected_completed_at": "2023-03-14T13:46:27-06:00",
    "contact_image_url": "string",
    "work_order_sub_line_items": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "description": "string",
        "item_id": 0,
        "item_type": "Contact",
        "work_order_line_item_id": 0,
        "quantity": 0,
        "part_location_detail_id": 0,
        "position": 0,
        "item_name": "string",
        "unit_cost": 0,
        "contact": {
          "id": 0,
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z",
          "email": "string",
          "name": "string",
          "first_name": "string",
          "middle_name": "string",
          "last_name": "string",
          "images_count": 0,
          "documents_count": 0,
          "comments_count": 0,
          "group_id": 0,
          "group_name": "string",
          "group_hierarchy": "Group 1|Group 2|Group 3",
          "technician": true,
          "vehicle_operator": true,
          "employee": true,
          "birth_date": "2023-03-14",
          "street_address": "123 Main St",
          "street_address_line_2": "Apt 1",
          "city": "string",
          "region": "string",
          "postal_code": "string",
          "country": "string",
          "employee_number": "string",
          "job_title": "string",
          "license_class": "string",
          "license_number": "string",
          "license_state": "string",
          "license_expiration": "2023-03-14",
          "home_phone_number": "string",
          "mobile_phone_number": "string",
          "work_phone_number": "string",
          "other_phone_number": "string",
          "start_date": "2024-07-29",
          "leave_date": "2024-07-29",
          "hourly_labor_rate": 0,
          "custom_fields": {},
          "attachment_permissions": {
            "read_photos": true,
            "manage_photos": true,
            "read_documents": true,
            "manage_documents": true
          },
          "default_image_url": "string",
          "user": {},
          "account_membership_id": 0,
          "last_api_request": "2024-07-29T15:51:28.071Z",
          "last_web_access": "2024-07-29T15:51:28.071Z",
          "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
        },
        "labor_time_entries": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "account_id": 0,
            "contact_id": 0,
            "duration_in_seconds": 0,
            "ended_at": "2023-03-14T13:46:27-06:00",
            "laborable_id": 0,
            "laborable_type": "WorkOrderSubLineItem",
            "started_at": "2023-03-14T13:46:27-06:00",
            "data": {
              "clock_in_latitude": 0,
              "clock_in_longitude": 0,
              "clock_out_latitude": 0,
              "clock_out_longitude": 0
            },
            "active": true
          }
        ]
      },
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "description": "string",
        "item_id": 0,
        "item_type": "Part",
        "work_order_line_item_id": 0,
        "quantity": 0,
        "part_location_detail_id": 0,
        "position": 0,
        "item_name": "string",
        "unit_cost": 0,
        "part": {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "description": "string",
          "manufacturer_part_number": "string",
          "measurement_unit_id": 0,
          "number": "string",
          "part_category_id": 0,
          "part_manufacturer_id": 0,
          "upc": "string",
          "total_quantity": 0,
          "custom_fields": {},
          "inventory_item": true,
          "part_category": {
            "id": 0,
            "tire_category": true
          },
          "part_category_name": "string",
          "part_manufacturer_name": "string",
          "measurement_unit_name": "string",
          "unit_cost": 0,
          "average_unit_cost": 0,
          "part_locations": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "active": true,
              "aisle": "string",
              "available_quantity": 0,
              "bin": "string",
              "inventory_sets_count": 0,
              "has_been_used_in_work_orders": true,
              "name": "string",
              "part_location_name": "string",
              "part_location_id": 0,
              "quantity_allocated_to_work_orders": 0,
              "quantity_on_order": 0,
              "reorder_point": 0,
              "reorder_point_enabled": true,
              "row": "string",
              "track_inventory": true,
              "available_quantity_updated_at": "2023-03-14T13:46:27-06:00",
              "part_location_archived_at": "2024-07-29T15:51:28.071Z"
            }
          ],
          "default_image_url": "string",
          "default_image_url_medium": "string",
          "default_image_url_small": "string",
          "default_image_url_large": "string",
          "archived_at": "2023-03-14T13:46:27-06:00",
          "attachment_permissions": {
            "read_photos": true,
            "manage_photos": true,
            "read_documents": true,
            "manage_documents": true
          },
          "has_active_inventory_sets": true,
          "tire_config": {
            "aspect_ratio": 0,
            "rim_diameter": 0,
            "load_index": 0,
            "metric_type": "EU",
            "width": 0,
            "construction": "B",
            "speed_rating": "A1",
            "factory_tread_depth": 0,
            "minimum_tread_depth": 0,
            "life_expectancy": 0
          },
          "comments": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "commentable_type": "Contact",
              "commentable_id": 0,
              "user_id": 0,
              "comment": "string",
              "user_full_name": "string",
              "user_image_url": "string",
              "rich_content": {},
              "html_content": "string",
              "with_mentions": true
            }
          ],
          "comments_count": 0,
          "documents": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "name": "string",
              "description": "string",
              "documentable_id": 0,
              "documentable_type": "ServiceEntry",
              "file_name": "string",
              "file_mime_type": "string",
              "file_size": 0,
              "file_url": "string",
              "full_file_url": "string"
            }
          ],
          "documents_count": 0,
          "images": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "imageable_id": 0,
              "imageable_type": "ExpenseEntry",
              "file_name": "string",
              "file_mime_type": "image/jpeg",
              "file_size": 0,
              "file_url": "string",
              "full_url": "string"
            }
          ],
          "images_count": 0
        }
      }
    ],
    "scheduled_at": "2023-03-14T13:46:27-06:00",
    "vehicle_id": 0,
    "vehicle_name": "string",
    "vendor_id": 0,
    "vendor_name": "string",
    "work_order_status_id": 0,
    "work_order_status_name": "string",
    "work_order_status_color": "string",
    "custom_fields": {},
    "work_order_line_items": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "description": "string",
        "title": "string",
        "item_id": 0,
        "item_type": "Issue",
        "work_order_line_item_id": 0,
        "item_name": "string",
        "position": 0,
        "issues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "vmrs_reason_for_repair": {
          "account_id": 0,
          "alias": "string",
          "code": "string",
          "enabled": true,
          "id": 0,
          "name": "string",
          "repair_type": "string",
          "standard": true,
          "standard_name": "string",
          "type": "string",
          "vmrs_standard_reason_for_repair": {}
        },
        "vmrs_system_group": {
          "account_id": 0,
          "assembly_code": "string",
          "assembly_name": "string",
          "code_type": "system_group",
          "component_code": "string",
          "component_name": "string",
          "enabled": true,
          "id": 0,
          "permissions": {
            "destroy": true
          },
          "standard": true,
          "system_code": "string",
          "system_group": "string",
          "system_group_code": "string",
          "system_name": "string",
          "type": "string",
          "vmrs_standard_system_assembly_component": {}
        },
        "vmrs_system": {
          "account_id": 0,
          "assembly_code": "string",
          "assembly_name": "string",
          "code_type": "system_group",
          "component_code": "string",
          "component_name": "string",
          "enabled": true,
          "id": 0,
          "permissions": {
            "destroy": true
          },
          "standard": true,
          "system_code": "string",
          "system_group": "string",
          "system_group_code": "string",
          "system_name": "string",
          "type": "string",
          "vmrs_standard_system_assembly_component": {}
        },
        "vmrs_assembly": {
          "account_id": 0,
          "assembly_code": "string",
          "assembly_name": "string",
          "code_type": "system_group",
          "component_code": "string",
          "component_name": "string",
          "enabled": true,
          "id": 0,
          "permissions": {
            "destroy": true
          },
          "standard": true,
          "system_code": "string",
          "system_group": "string",
          "system_group_code": "string",
          "system_name": "string",
          "type": "string",
          "vmrs_standard_system_assembly_component": {}
        },
        "vmrs_component": {
          "account_id": 0,
          "assembly_code": "string",
          "assembly_name": "string",
          "code_type": "system_group",
          "component_code": "string",
          "component_name": "string",
          "enabled": true,
          "id": 0,
          "permissions": {
            "destroy": true
          },
          "standard": true,
          "system_code": "string",
          "system_group": "string",
          "system_group_code": "string",
          "system_name": "string",
          "type": "string",
          "vmrs_standard_system_assembly_component": {}
        },
        "work_order_sub_line_items": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "description": "string",
            "item_id": 0,
            "item_type": "Contact",
            "work_order_line_item_id": 0,
            "quantity": 0,
            "part_location_detail_id": 0,
            "position": 0,
            "item_name": "string",
            "unit_cost": 0,
            "contact": {
              "id": 0,
              "created_at": "2024-07-29T15:51:28.071Z",
              "updated_at": "2024-07-29T15:51:28.071Z",
              "email": "string",
              "name": "string",
              "first_name": "string",
              "middle_name": "string",
              "last_name": "string",
              "images_count": 0,
              "documents_count": 0,
              "comments_count": 0,
              "group_id": 0,
              "group_name": "string",
              "group_hierarchy": "Group 1|Group 2|Group 3",
              "technician": true,
              "vehicle_operator": true,
              "employee": true,
              "birth_date": "2023-03-14",
              "street_address": "123 Main St",
              "street_address_line_2": "Apt 1",
              "city": "string",
              "region": "string",
              "postal_code": "string",
              "country": "string",
              "employee_number": "string",
              "job_title": "string",
              "license_class": "string",
              "license_number": "string",
              "license_state": "string",
              "license_expiration": "2023-03-14",
              "home_phone_number": "string",
              "mobile_phone_number": "string",
              "work_phone_number": "string",
              "other_phone_number": "string",
              "start_date": "2024-07-29",
              "leave_date": "2024-07-29",
              "hourly_labor_rate": 0,
              "custom_fields": {},
              "attachment_permissions": {
                "read_photos": true,
                "manage_photos": true,
                "read_documents": true,
                "manage_documents": true
              },
              "default_image_url": "string",
              "user": {},
              "account_membership_id": 0,
              "last_api_request": "2024-07-29T15:51:28.071Z",
              "last_web_access": "2024-07-29T15:51:28.071Z",
              "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
            },
            "labor_time_entries": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "account_id": 0,
                "contact_id": 0,
                "duration_in_seconds": 0,
                "ended_at": "2023-03-14T13:46:27-06:00",
                "laborable_id": 0,
                "laborable_type": "WorkOrderSubLineItem",
                "started_at": "2023-03-14T13:46:27-06:00",
                "data": {
                  "clock_in_latitude": 0,
                  "clock_in_longitude": 0,
                  "clock_out_latitude": 0,
                  "clock_out_longitude": 0
                },
                "active": true
              }
            ]
          },
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "description": "string",
            "item_id": 0,
            "item_type": "Part",
            "work_order_line_item_id": 0,
            "quantity": 0,
            "part_location_detail_id": 0,
            "position": 0,
            "item_name": "string",
            "unit_cost": 0,
            "part": {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "description": "string",
              "manufacturer_part_number": "string",
              "measurement_unit_id": 0,
              "number": "string",
              "part_category_id": 0,
              "part_manufacturer_id": 0,
              "upc": "string",
              "total_quantity": 0,
              "custom_fields": {},
              "inventory_item": true,
              "part_category": {
                "id": 0,
                "tire_category": true
              },
              "part_category_name": "string",
              "part_manufacturer_name": "string",
              "measurement_unit_name": "string",
              "unit_cost": 0,
              "average_unit_cost": 0,
              "part_locations": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "active": true,
                  "aisle": "string",
                  "available_quantity": 0,
                  "bin": "string",
                  "inventory_sets_count": 0,
                  "has_been_used_in_work_orders": true,
                  "name": "string",
                  "part_location_name": "string",
                  "part_location_id": 0,
                  "quantity_allocated_to_work_orders": 0,
                  "quantity_on_order": 0,
                  "reorder_point": 0,
                  "reorder_point_enabled": true,
                  "row": "string",
                  "track_inventory": true,
                  "available_quantity_updated_at": "2023-03-14T13:46:27-06:00",
                  "part_location_archived_at": "2024-07-29T15:51:28.071Z"
                }
              ],
              "default_image_url": "string",
              "default_image_url_medium": "string",
              "default_image_url_small": "string",
              "default_image_url_large": "string",
              "archived_at": "2023-03-14T13:46:27-06:00",
              "attachment_permissions": {
                "read_photos": true,
                "manage_photos": true,
                "read_documents": true,
                "manage_documents": true
              },
              "has_active_inventory_sets": true,
              "tire_config": {
                "aspect_ratio": 0,
                "rim_diameter": 0,
                "load_index": 0,
                "metric_type": "EU",
                "width": 0,
                "construction": "B",
                "speed_rating": "A1",
                "factory_tread_depth": 0,
                "minimum_tread_depth": 0,
                "life_expectancy": 0
              },
              "comments": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "commentable_type": "Contact",
                  "commentable_id": 0,
                  "user_id": 0,
                  "comment": "string",
                  "user_full_name": "string",
                  "user_image_url": "string",
                  "rich_content": {},
                  "html_content": "string",
                  "with_mentions": true
                }
              ],
              "comments_count": 0,
              "documents": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "name": "string",
                  "description": "string",
                  "documentable_id": 0,
                  "documentable_type": "ServiceEntry",
                  "file_name": "string",
                  "file_mime_type": "string",
                  "file_size": 0,
                  "file_url": "string",
                  "full_file_url": "string"
                }
              ],
              "documents_count": 0,
              "images": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "imageable_id": 0,
                  "imageable_type": "ExpenseEntry",
                  "file_name": "string",
                  "file_mime_type": "image/jpeg",
                  "file_size": 0,
                  "file_url": "string",
                  "full_url": "string"
                }
              ],
              "images_count": 0
            }
          }
        ],
        "subtotal": 1.23,
        "subtotal_cents": 0,
        "labor_cost": 1.23,
        "parts_cost": 1.23,
        "parts_cost_cents": 0,
        "labor_cost_cents": 0
      }
    ],
    "labor_time_entries": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "account_id": 0,
        "contact_id": 0,
        "duration_in_seconds": 0,
        "ended_at": "2023-03-14T13:46:27-06:00",
        "laborable_id": 0,
        "laborable_type": "WorkOrderSubLineItem",
        "started_at": "2023-03-14T13:46:27-06:00",
        "data": {
          "clock_in_latitude": 0,
          "clock_in_longitude": 0,
          "clock_out_latitude": 0,
          "clock_out_longitude": 0
        },
        "active": true
      }
    ],
    "meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "starting_meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "ending_meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "secondary_meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "starting_secondary_meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "ending_secondary_meter_entry": {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "secondary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "date": "2023-03-14"
    },
    "attachment_permissions": {
      "read_photos": true,
      "manage_photos": true,
      "read_documents": true,
      "manage_documents": true
    },
    "vmrs_repair_priority_class": {
      "id": 0,
      "code": "string",
      "name": "string",
      "color": "string"
    },
    "labels": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "issues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "watchers_count": 0,
    "is_watched": true,
    "discount_type": "percentage",
    "discount_percentage": 1.23,
    "discount": 1.23,
    "parts_subtotal": 1.23,
    "labor_subtotal": 1.23,
    "subtotal": 1.23,
    "tax_1_type": "percentage",
    "tax_1_percentage": 1.23,
    "tax_2_type": "percentage",
    "tax_2_percentage": 1.23,
    "tax_1": 1.23,
    "tax_2": 1.23,
    "parts_markup_type": "fixed",
    "parts_markup": 1.23,
    "parts_markup_percentage": 1.23,
    "labor_markup_type": "fixed",
    "labor_markup": 1.23,
    "labor_markup_percentage": 1.23,
    "total_amount": 1.23,
    "labor_time_in_seconds": 0,
    "comments": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "commentable_type": "Contact",
        "commentable_id": 0,
        "user_id": 0,
        "comment": "string",
        "user_full_name": "string",
        "user_image_url": "string",
        "rich_content": {},
        "html_content": "string",
        "with_mentions": true
      }
    ],
    "comments_count": 0,
    "images": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "imageable_id": 0,
        "imageable_type": "ExpenseEntry",
        "file_name": "string",
        "file_mime_type": "image/jpeg",
        "file_size": 0,
        "file_url": "string",
        "full_url": "string"
      }
    ],
    "images_count": 0,
    "documents": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "name": "string",
        "description": "string",
        "documentable_id": 0,
        "documentable_type": "ServiceEntry",
        "file_name": "string",
        "file_mime_type": "string",
        "file_size": 0,
        "file_url": "string",
        "full_file_url": "string"
      }
    ],
    "documents_count": 0
  }
]

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/work_orders' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

ResponseClear

Click the Send API Request button above and see the response here!