--- title: "Retrieve Work Order" method: GET path: "/work_orders/{id}" tags: ["Work Orders"] --- # Retrieve Work Order `GET /work_orders/{id}` ## Request - Base URL: `https://secure.fleetio.com/api` - URL: `https://secure.fleetio.com/api/work_orders/{id}` - Auth: API key in header `Authorization` and API key in header `Account-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve the details of an existing Work Order. ## Path parameters - `id` string, required ## Response `200` OK - WorkOrder, nullable: A Work Order - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `number` string, required: The unique number of this Work Order. - `completed_at` string, date-time, nullable, required: The date and time at which the Work Order was completed. - `description` string, nullable, required: A description of this Work Order. - `ending_meter_same_as_start` boolean, required: Indicates whether or not the ending meter is the same as the starting meter. - `duration_in_seconds` integer, nullable, required: The number of seconds elapsed between beginning this Work Order and completing it. - `invoice_number` string, nullable, required: The number of the `Invoice` associated with this Work Order. - `created_by_id` integer, required: The id of the `User` who created this Work Order. - `state` 'active' | 'completed', required: Indicates whether this Work Order is currently active or has already been completed. - `issued_at` string, date-time, required: The date and time at which the Work Order was issued. - `issued_by_id` integer, nullable, required - `issued_by_name` string, nullable, required: The name of the `Contact` associated with the `User` who issued this Work Order. - `contact_id` integer, nullable, required - `contact_name` string, nullable, required: The name of the `Contact` currently assigned to this Work Order. - `purchase_order_number` string, nullable, required: The number of any `Purchase Order` associated with this Work Order. - `started_at` string, date-time, nullable, required: The date and time at which the Work Order was started. - `expected_completed_at` string, date-time, nullable: The date and time at which the Work Order is expected to be completed. - `contact_image_url` string, nullable: The URL of the image associated with the `Contact` currently assigned to this Work Order. - `work_order_sub_line_items` WorkOrderSubLineItem[], required - union - WorkOrderSubLineItemForContact, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of the sub line item. - `item_id` integer - `item_type` 'Contact' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float: The unit cost of this sub line item. - `contact` Contact, nullable: A Contact - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `email` string, nullable: The Contact's email address. - `name` string, nullable: The Contact's full name. - `first_name` string, nullable: The Contact's first name. - `middle_name` string, nullable: The Contact's middle name. - `last_name` string, nullable: The Contact's last name. - `images_count` integer: The number of images associated with this Contact. - `documents_count` integer: The number of documents associated with this Contact. - `comments_count` integer: The number of comments associated with this Contact. - `group_id` integer, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the Fleetio ID of that `Group`. - `group_name` string, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the `Group`'s name. - `group_hierarchy` string, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be a pipe delimited string representing the `Group` hierarchy. Each `Group` in the list is the parent of the `Groups` which follow. - `technician` boolean, nullable: Whether or not the Contact is a Technician. - `vehicle_operator` boolean, nullable: Whether or not the Contact is a Vehicle Operator. - `employee` boolean, nullable: Whether or not the Contact is an Employee. - `birth_date` string, date, nullable: The Contact's birth date. - `street_address` string, nullable: The Contact's street address. - `street_address_line_2` string, nullable: The Contact's street address line 2. - `city` string, nullable: The Contact's city. - `region` string, nullable: The Contact's region, state, or province. - `postal_code` string, nullable: The Contact's postal code, zip code, or equivalent. - `country` string, nullable: The Contact's country. - `employee_number` string, nullable: The Contact's employee number. - `job_title` string, nullable: The Contact's job title. - `license_class` string, nullable: The Contact's driver's license class. - `license_number` string, nullable: The Contact's driver's license number. - `license_state` string, nullable: The locality which issued the Contact's license. - `license_expiration` string, date, nullable: The Contact's driver's license expiration date. - `home_phone_number` string, nullable: The Contact's home phone number. - `mobile_phone_number` string, nullable: The Contact's mobile phone number. - `work_phone_number` string, nullable: The Contact's work phone number. - `other_phone_number` string, nullable: Any other phone number for this Contact. - `start_date` string, date, nullable: When the Contact started working for the company, if applicable. - `leave_date` string, date, nullable: When the Contact left or will leave the company, if applicable. - `hourly_labor_rate` number, float, nullable: The Contact's hourly rate. - `custom_fields` CustomFields, nullable: *Full details on working with Custom Fields [here](/docs/overview/custom-fields). - `attachment_permissions` AttachmentPermissions, nullable - `read_photos` boolean: Indicates whether the user has read permission for photos. - `manage_photos` boolean: Indicates whether the user has permission to manage (eg. upload, delete) photos. - `read_documents` boolean: Indicates whether the user has read permission for documents. - `manage_documents` boolean: Indicates whether the user has permission to manage (eg. upload, delete) documents. - `default_image_url` string, nullable: The URL of the Contact's default image/profile photo, if any. - `user` object, nullable: If the Contact is a Fleetio `User`, those details will be included here. - `account_membership_id` integer, nullable - `last_api_request` string, date-time, nullable: The last date and time this Contact's associated User made an API request. Null if Contact is not associated with a User. - `last_web_access` string, date-time, nullable: The last date and time this Contact's associated User signed into the web application. Null if Contact is not associated with a User. - `last_mobile_app_access` string, date-time, nullable: The last date and time this Contact's associated User used the mobile app. Null if Contact is not associated with a User. - `labor_time_entries` LaborTimeEntry[] - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `account_id` integer - `contact_id` integer - `duration_in_seconds` integer - `ended_at` string, date-time, nullable - `laborable_id` integer - `laborable_type` 'WorkOrderSubLineItem' - `started_at` string, date-time - `data` object - `clock_in_latitude` number, float - `clock_in_longitude` number, float - `clock_out_latitude` number, float - `clock_out_longitude` number, float - `active` boolean: Indicates whether this Labor Time Entry is active. - WorkOrderSubLineItemForPart, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of this sub line item. - `item_id` integer: The ID of the `Part` associated with this sub line item. - `item_type` 'Part' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float, nullable: The unit cost of this sub line item. - `part` Part, nullable: A Part - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable, required: A description of this Part. - `manufacturer_part_number` string, nullable, required: The part number from this Part's manufacturer. - `measurement_unit_id` integer, nullable, required - `number` string, required: The part number being used for this Part within Fleetio. - `part_category_id` integer, nullable, required - `part_manufacturer_id` integer, nullable, required - `upc` string, nullable, required: The Universal Product Code for this Part. - `total_quantity` number, float, required: The total quantity on hand for this Part. - `custom_fields` CustomFields, nullable, required: *Full details on working with Custom Fields [here](/docs/overview/custom-fields). - `inventory_item` boolean, required: Indicates whether or not this Part is an inventory item. - `part_category` PartCategory, nullable - `id` integer - `tire_category` boolean: Indicates whether part is a tire or not - `part_category_name` string, nullable, required: The name of the part category associated with this Part. - `part_manufacturer_name` string, nullable, required: The name of the Part's manufacturer. - `measurement_unit_name` string, nullable, required: The measurement unit used by this Part. - `unit_cost` number, float, nullable, required: The unit cost for this Part. - `average_unit_cost` number, float, nullable: The average unit cost for this Part. FIFO/LIFO accounts only. - `part_locations` PartLocationDetail[], required - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `active` boolean: Whether this Part Location is active. - `aisle` string, nullable: The aisle in which the Part is located. - `available_quantity` number, float: How many of this Part are available at this Part Location. - `bin` string, nullable: The bin in which the Part is located. - `inventory_sets_count` integer: The number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only. - `has_been_used_in_work_orders` boolean, nullable: Whether this Part has been used in any Work Orders. FIFO/LIFO accounts only. - `name` string: Alias of `part_location_name`. - `part_location_name` string: The name of the Part Location for this Part. - `part_location_id` integer: The ID of the Part Location for this Part. - `quantity_allocated_to_work_orders` number, float, nullable: How many of these Parts are currently allocated to `Work Orders`. - `quantity_on_order` number, float, nullable: How many of this Part are currently on order, if any. - `reorder_point` number, float: The lower-threshold quantity at which this Part should be reordered. - `reorder_point_enabled` boolean: Whether this Part will be reordered at the reorder point. - `row` string, nullable: The row in which the Part is located. - `track_inventory` boolean: Indicates whether inventory is tracked for this Part at this location. - `available_quantity_updated_at` string, date-time, nullable - `part_location_archived_at` string, date-time, nullable: The date and time at which the `Part Location` was archived, if applicable. - `default_image_url` string, nullable, required - `default_image_url_medium` string, nullable, required - `default_image_url_small` string, nullable, required - `default_image_url_large` string, nullable, required - `archived_at` string, date-time, nullable, required: The date and time at which this Part was archived. - `attachment_permissions` AttachmentPermissions, nullable, required - `read_photos` boolean: Indicates whether the user has read permission for photos. - `manage_photos` boolean: Indicates whether the user has permission to manage (eg. upload, delete) photos. - `read_documents` boolean: Indicates whether the user has read permission for documents. - `manage_documents` boolean: Indicates whether the user has permission to manage (eg. upload, delete) documents. - `has_active_inventory_sets` boolean: Indicates whether this Part has any active [Inventory Sets](/docs/api/v-3-part-location-detail-inventory-sets-index). FIFO/LIFO accounts only. - `tire_config` object - `id` integer - `aspect_ratio` number, float: Aspect ratio of tire. - `rim_diameter` number, float: Rim diameter of tire. - `load_index` number, float: Load index of tire. - `metric_type` 'EU' | 'P' | 'HL' | 'T' | 'LT' | 'C' | 'ST': Metric type of tire. - `width` number, float: Width of tire. - `construction` 'B' | 'R' | 'D': Construction type of tire. - `speed_rating` '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': Speed rating of tire. - `factory_tread_depth` number, float: Tread depth of tire in /32" when new, as specified by the manufacturer. - `minimum_tread_depth` number, float: The legal minimum tread depth, in /32". - `life_expectancy` integer: 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. - `cross_reference_members` PartCrossReferenceMember[]: Other Parts in this Part's cross-reference group. Only present when the cross-references feature is enabled for the account; omitted entirely on index/archived responses. - `id` integer, nullable, required - `number` string, required: The part number being used for this Part within Fleetio. - `description` string, nullable, required: A description of this Part. - `part_category_name` string, nullable, required: The name of the part category associated with this Part. - `part_manufacturer_name` string, nullable, required: The name of the Part's manufacturer. - `manufacturer_part_number` string, nullable, required: The part number from this Part's manufacturer. - `total_quantity` number, float, required: The total quantity on hand for this Part. Like `available_quantity`, it is not affected by `part_location_id`. The value stays account-wide even when the request narrows `part_location_details` to a single location. - `unit_cost` number, float, nullable, required: The unit cost for this Part. - `unit_cost_unit` string, nullable, required: The measurement unit used by this Part. - `available_quantity` number, float, required: The total quantity on hand for this Part at locations the current API credentials can read. It is not affected by `part_location_id`. The value stays account-wide even when the request narrows `part_location_details` to a single location, which is where per-location quantities live. - `default_image_small_square_url` string, nullable, required - `position` integer, required: This Part's rank within the shared cross-reference group. Values are not contiguous once `with_cross_reference_member_locations` narrows the members returned. A group of five narrowed to two can return positions 1 and 4. - `part_location_details` PartCrossReferenceMemberLocation[]: This member's per-location stock, sorted by Part Location name. Only present when the request opts in with `with_cross_reference_member_locations`. The array holds active Part Locations only, is further narrowed to `part_location_id` when one is given, and always omits Part Locations the current API credentials cannot read. - … - `cross_reference_group_id` integer, nullable: The cross-reference group this Part belongs to, or `null` when it belongs to none. Unlike `cross_reference_members` this is present on index and archived responses as well, so a list can be read for which Parts have compatible Parts without a request per Part -- and two Parts sharing a value are compatible with each other. Only present when the cross-references feature is enabled for the account. - `comments` Comment[], required: A list of the comments made on this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `commentable_type` 'Contact' | 'FleetcorCard' | 'FuelEntry' | 'InventoryJournalEntry' | 'Issue' | 'Part' | 'PurchaseOrder' | 'ServiceEntry' | 'ServiceReminder' | 'SubmittedInspectionItem' | 'Vehicle' | 'VehicleAssignment' | 'Vendor' | 'WexCard' | 'WorkOrder', required: The type of record that the Comment will be left on. Must be associated with a matching `commentable_id`. - `commentable_id` integer, required - `user_id` integer, required - `title` string: The title of the Comment. - `comment` string, required: The content of the Comment message body. - `user_full_name` string, required: The full name of the `User` who created the Comment. - `user_image_url` string, nullable, required: The image url for the `User` who created the Comment. - `rich_content` object, nullable, required - `html_content` string, nullable, required: The comment message body rendered as HTML. - `with_mentions` boolean, required: Indicates if the message body contains @mentions. - `comments_count` integer, required: The number of comments made on this record. - `documents` Document[], required: A list of the documents attached to this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `name` string, required: The name of the document. - `description` string, required: The description of the document. - `documentable_id` integer, required - `documentable_type` 'ServiceEntry' | 'FuelEntry' | 'Issue' | 'WorkOrder' | 'ExpenseEntry' | 'Vehicle', required - `file_name` string, required: The name of the file. - `file_mime_type` string, required: The MIME type of the file. - `file_size` number, required: The size of the file in bytes. - `file_url` string, required: The URL to access the file. - `full_file_url` string, required: The full URL to access the file, including any necessary authentication or parameters. - `documents_count` integer, required: The number of documents attached to this record. - `images` Image2[], required: A list of the images attached to this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `imageable_id` integer - `imageable_type` 'ExpenseEntry' | 'WorkOrder' | 'Equipment' | 'IssueResolution' | 'ServiceEntry' | 'Vendor' | 'ServiceProgram' | 'Issue' | 'Contact' | 'Part' | 'Vehicle' | 'FuelEntry' | 'SubmittedInspectionItem' - `file_name` string: The name of the image file. - `file_mime_type` '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_size` number: The size of the image file in bytes. - `file_url` string: The URL to access the image file. - `full_url` string: The full URL to access the image file, including any necessary authentication or parameters. - `images_count` integer, required: The number of images attached to this record. - WorkOrderSubLineItemForInspectionForm, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of this sub line item. - `item_id` integer: The ID of the `Inspection Form` associated with this sub line item. - `item_type` 'InspectionForm' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float, nullable: The unit cost of this sub line item. - `inspection_form` object: The `Inspection Form` associated with this sub line item. - `id` integer - `title` string - `color` string, nullable - `submitted_inspection_form` object, nullable: The submitted `Inspection Form`, when one has been submitted for this line item. - `id` integer - `contact` object: The `Contact` who submitted the Inspection Form, when available. - `id` integer - `name` string - `email` string, nullable - `employee` boolean - `employee_number` string, nullable - `group_id` integer, nullable - `default_image_url` string, nullable - `scheduled_at` string, date-time, nullable, required: The date and time at which the Work Order was scheduled. - `vehicle_id` integer, required - `vehicle_name` string, required: The name of the `Vehicle` associated with this Work Order. - `vendor_id` integer, nullable, required - `vendor_name` string, nullable, required: The name of the `Vendor` associated with this Work Order. - `work_order_status_id` integer, required - `work_order_status_name` string, required: The name of the `Work Order Status` associated with this Work Order. - `work_order_status_color` string, nullable, required: The color of the `Work Order Status` seen in the UI. - `custom_fields` CustomFields, nullable, required: *Full details on working with Custom Fields [here](/docs/overview/custom-fields). - `work_order_line_items` WorkOrderLineItem[], required - `id` integer - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable, required: A description of this Work Order Line Item. - `title` string: The title of this Work Order Line Item. - `item_id` integer, required: The ID of the item associated with this Work Order Line Item. - `item_type` 'Issue' | 'ServiceTask', required: The type of item associated with this Work Order Line Item. - `work_order_line_item_id` integer, nullable, required - `item_name` string, required: The name of the item associated with this Work Order Line Item. - `position` integer, nullable, required: 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. - `id` integer: The ID of the `Issue`. - `name` string: The name of the `Issue`. - `vmrs_reason_for_repair` object, nullable, required - `account_id` integer - `alias` string, nullable - `code` string, nullable - `enabled` boolean - `id` integer - `name` string - `repair_type` string, nullable - `standard` boolean - `standard_name` string, nullable - `type` string - `vmrs_standard_reason_for_repair` object, nullable - `vmrs_system_group` object, nullable, required - `account_id` number, nullable - `assembly_code` string, nullable - `assembly_name` string, nullable - `code_type` 'system_group' | 'system' | 'assembly' | 'component' - `component_code` string, nullable - `component_name` string, nullable - `enabled` boolean - `id` integer - `permissions` object, nullable - `destroy` boolean - `standard` boolean - `system_code` string, nullable - `system_group` string, nullable - `system_group_code` string, nullable - `system_name` string, nullable - `type` string - `vmrs_standard_system_assembly_component` object, nullable - `vmrs_system` object, nullable, required - `account_id` number, nullable - `assembly_code` string, nullable - `assembly_name` string, nullable - `code_type` 'system_group' | 'system' | 'assembly' | 'component' - `component_code` string, nullable - `component_name` string, nullable - `enabled` boolean - `id` integer - `permissions` object, nullable - `destroy` boolean - `standard` boolean - `system_code` string, nullable - `system_group` string, nullable - `system_group_code` string, nullable - `system_name` string, nullable - `type` string - `vmrs_standard_system_assembly_component` object, nullable - `vmrs_assembly` object, nullable, required - `account_id` number, nullable - `assembly_code` string, nullable - `assembly_name` string, nullable - `code_type` 'system_group' | 'system' | 'assembly' | 'component' - `component_code` string, nullable - `component_name` string, nullable - `enabled` boolean - `id` integer - `permissions` object, nullable - `destroy` boolean - `standard` boolean - `system_code` string, nullable - `system_group` string, nullable - `system_group_code` string, nullable - `system_name` string, nullable - `type` string - `vmrs_standard_system_assembly_component` object, nullable - `vmrs_component` object, nullable, required - `account_id` number, nullable - `assembly_code` string, nullable - `assembly_name` string, nullable - `code_type` 'system_group' | 'system' | 'assembly' | 'component' - `component_code` string, nullable - `component_name` string, nullable - `enabled` boolean - `id` integer - `permissions` object, nullable - `destroy` boolean - `standard` boolean - `system_code` string, nullable - `system_group` string, nullable - `system_group_code` string, nullable - `system_name` string, nullable - `type` string - `vmrs_standard_system_assembly_component` object, nullable - `work_order_sub_line_items` WorkOrderSubLineItem[], required - union - WorkOrderSubLineItemForContact, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of the sub line item. - `item_id` integer - `item_type` 'Contact' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float: The unit cost of this sub line item. - `contact` Contact, nullable: A Contact - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `email` string, nullable: The Contact's email address. - `name` string, nullable: The Contact's full name. - `first_name` string, nullable: The Contact's first name. - `middle_name` string, nullable: The Contact's middle name. - `last_name` string, nullable: The Contact's last name. - `images_count` integer: The number of images associated with this Contact. - `documents_count` integer: The number of documents associated with this Contact. - `comments_count` integer: The number of comments associated with this Contact. - `group_id` integer, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the Fleetio ID of that `Group`. - `group_name` string, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the `Group`'s name. - `group_hierarchy` string, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be a pipe delimited string representing the `Group` hierarchy. Each `Group` in the list is the parent of the `Groups` which follow. - `technician` boolean, nullable: Whether or not the Contact is a Technician. - `vehicle_operator` boolean, nullable: Whether or not the Contact is a Vehicle Operator. - `employee` boolean, nullable: Whether or not the Contact is an Employee. - `birth_date` string, date, nullable: The Contact's birth date. - `street_address` string, nullable: The Contact's street address. - `street_address_line_2` string, nullable: The Contact's street address line 2. - `city` string, nullable: The Contact's city. - `region` string, nullable: The Contact's region, state, or province. - `postal_code` string, nullable: The Contact's postal code, zip code, or equivalent. - `country` string, nullable: The Contact's country. - `employee_number` string, nullable: The Contact's employee number. - `job_title` string, nullable: The Contact's job title. - `license_class` string, nullable: The Contact's driver's license class. - `license_number` string, nullable: The Contact's driver's license number. - `license_state` string, nullable: The locality which issued the Contact's license. - `license_expiration` string, date, nullable: The Contact's driver's license expiration date. - `home_phone_number` string, nullable: The Contact's home phone number. - `mobile_phone_number` string, nullable: The Contact's mobile phone number. - `work_phone_number` string, nullable: The Contact's work phone number. - `other_phone_number` string, nullable: Any other phone number for this Contact. - `start_date` string, date, nullable: When the Contact started working for the company, if applicable. - `leave_date` string, date, nullable: When the Contact left or will leave the company, if applicable. - `hourly_labor_rate` number, float, nullable: The Contact's hourly rate. - `custom_fields` CustomFields, nullable: *Full details on working with Custom Fields [here](/docs/overview/custom-fields). - `attachment_permissions` AttachmentPermissions, nullable - … - `default_image_url` string, nullable: The URL of the Contact's default image/profile photo, if any. - `user` object, nullable: If the Contact is a Fleetio `User`, those details will be included here. - `account_membership_id` integer, nullable - `last_api_request` string, date-time, nullable: The last date and time this Contact's associated User made an API request. Null if Contact is not associated with a User. - `last_web_access` string, date-time, nullable: The last date and time this Contact's associated User signed into the web application. Null if Contact is not associated with a User. - `last_mobile_app_access` string, date-time, nullable: The last date and time this Contact's associated User used the mobile app. Null if Contact is not associated with a User. - `labor_time_entries` LaborTimeEntry[] - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `account_id` integer - `contact_id` integer - `duration_in_seconds` integer - `ended_at` string, date-time, nullable - `laborable_id` integer - `laborable_type` 'WorkOrderSubLineItem' - `started_at` string, date-time - `data` object - … - `active` boolean: Indicates whether this Labor Time Entry is active. - WorkOrderSubLineItemForPart, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of this sub line item. - `item_id` integer: The ID of the `Part` associated with this sub line item. - `item_type` 'Part' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float, nullable: The unit cost of this sub line item. - `part` Part, nullable: A Part - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable, required: A description of this Part. - `manufacturer_part_number` string, nullable, required: The part number from this Part's manufacturer. - `measurement_unit_id` integer, nullable, required - `number` string, required: The part number being used for this Part within Fleetio. - `part_category_id` integer, nullable, required - `part_manufacturer_id` integer, nullable, required - `upc` string, nullable, required: The Universal Product Code for this Part. - `total_quantity` number, float, required: The total quantity on hand for this Part. - `custom_fields` CustomFields, nullable, required: *Full details on working with Custom Fields [here](/docs/overview/custom-fields). - `inventory_item` boolean, required: Indicates whether or not this Part is an inventory item. - `part_category` PartCategory, nullable - … - `part_category_name` string, nullable, required: The name of the part category associated with this Part. - `part_manufacturer_name` string, nullable, required: The name of the Part's manufacturer. - `measurement_unit_name` string, nullable, required: The measurement unit used by this Part. - `unit_cost` number, float, nullable, required: The unit cost for this Part. - `average_unit_cost` number, float, nullable: The average unit cost for this Part. FIFO/LIFO accounts only. - `part_locations` PartLocationDetail[], required - … - `default_image_url` string, nullable, required - `default_image_url_medium` string, nullable, required - `default_image_url_small` string, nullable, required - `default_image_url_large` string, nullable, required - `archived_at` string, date-time, nullable, required: The date and time at which this Part was archived. - `attachment_permissions` AttachmentPermissions, nullable, required - … - `has_active_inventory_sets` boolean: Indicates whether this Part has any active [Inventory Sets](/docs/api/v-3-part-location-detail-inventory-sets-index). FIFO/LIFO accounts only. - `tire_config` object - … - `cross_reference_members` PartCrossReferenceMember[]: Other Parts in this Part's cross-reference group. Only present when the cross-references feature is enabled for the account; omitted entirely on index/archived responses. - … - `cross_reference_group_id` integer, nullable: The cross-reference group this Part belongs to, or `null` when it belongs to none. Unlike `cross_reference_members` this is present on index and archived responses as well, so a list can be read for which Parts have compatible Parts without a request per Part -- and two Parts sharing a value are compatible with each other. Only present when the cross-references feature is enabled for the account. - `comments` Comment[], required: A list of the comments made on this record. - … - `comments_count` integer, required: The number of comments made on this record. - `documents` Document[], required: A list of the documents attached to this record. - … - `documents_count` integer, required: The number of documents attached to this record. - `images` Image2[], required: A list of the images attached to this record. - … - `images_count` integer, required: The number of images attached to this record. - WorkOrderSubLineItemForInspectionForm, nullable: A Work Order Sub Line Item - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `description` string, nullable: The description of this sub line item. - `item_id` integer: The ID of the `Inspection Form` associated with this sub line item. - `item_type` 'InspectionForm' - `work_order_line_item_id` integer, nullable - `quantity` number, float: The quantity of this sub line item. - `part_location_detail_id` integer, nullable - `position` integer, nullable: The position of this sub line item in a list of sub line items. - `item_name` string: The name of this sub line item. - `unit_cost` number, float, nullable: The unit cost of this sub line item. - `inspection_form` object: The `Inspection Form` associated with this sub line item. - `id` integer - `title` string - `color` string, nullable - `submitted_inspection_form` object, nullable: The submitted `Inspection Form`, when one has been submitted for this line item. - `id` integer - `contact` object: The `Contact` who submitted the Inspection Form, when available. - … - `subtotal` number, float, nullable: The pre-tax subtotal amount. - `subtotal_cents` integer, nullable: The pre-tax subtotal amount in cents. - `labor_cost` number, float, nullable: The cost of labor units worked. - `parts_cost` number, float, nullable: The cost of parts. - `parts_cost_cents` integer, nullable: The parts cost amount in cents. - `labor_cost_cents` integer, nullable: The cost of labor units worked, in cents. - `labor_time_entries` LaborTimeEntry[], required - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `account_id` integer - `contact_id` integer - `duration_in_seconds` integer - `ended_at` string, date-time, nullable - `laborable_id` integer - `laborable_type` 'WorkOrderSubLineItem' - `started_at` string, date-time - `data` object - `clock_in_latitude` number, float - `clock_in_longitude` number, float - `clock_out_latitude` number, float - `clock_out_longitude` number, float - `active` boolean: Indicates whether this Labor Time Entry is active. - `meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `starting_meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `ending_meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `secondary_meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `starting_secondary_meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `ending_secondary_meter_entry` VehicleMeterEntry, nullable: A Meter Entry - `id` integer - `created_at` string, date-time - `updated_at` string, date-time - `auto_voided_at` string, date-time, nullable: The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in `User`'s local time. - `category` 'starting' | 'ending' | 'nightly' | 'manual', nullable: A category to describe the function of this Meter Entry. - `meter_type` 'secondary', nullable: Indicates whether or not this Meter is a secondary Meter. - `meterable_id` integer, nullable - `meterable_type` 'FuelEntry' | 'Issue' | 'PurchaseDetail' | 'ServiceEntry' | 'SubmittedInspectionItem' | 'VehicleAssignment' | 'WorkOrder', nullable: The type of the object with which this Meter Entry is associated. - `value` string: The current value of the meter. - `vehicle_id` integer, nullable - `void` boolean: Indicates whether or not this Meter Entry has been voided. - `type` 'GpsMeterEntry', nullable - `date` string, date: The date on which this Meter Entry was recorded. Formatted according to ISO-8601. - `attachment_permissions` AttachmentPermissions, nullable - `read_photos` boolean: Indicates whether the user has read permission for photos. - `manage_photos` boolean: Indicates whether the user has permission to manage (eg. upload, delete) photos. - `read_documents` boolean: Indicates whether the user has read permission for documents. - `manage_documents` boolean: Indicates whether the user has permission to manage (eg. upload, delete) documents. - `vmrs_repair_priority_class` object, nullable, required: The VMRS Repair Priority Class associated with this Work Order. - `id` integer: The ID of the VMRS Repair Priority Class. - `code` string: The code of the VMRS Repair Priority Class. - `name` string: The name of the VMRS Repair Priority Class. - `color` string: The color of the VMRS Repair Priority Class. - `labels` object[], required - `id` integer - `name` string - `issues` object[], required: Any `Issues` associated with this Work Order. - `id` integer: The ID of the `Issue`. - `name` string: The name of the `Issue`. - `watchers_count` integer: The number of `Users` watching this Work Order. - `is_watched` boolean: Indicates whether the current `User` is watching this Work Order. - `discount_type` 'fixed' | 'percentage', nullable, required: The type of discount applied to this record. - `discount_percentage` number, float, nullable, required: The discount percentage. This field should be present when `discount_type` is set to `percentage`. - `discount` number, float, nullable, required: The discount amount. - `parts_subtotal` number, float, nullable, required: The total cost of parts for this record. - `labor_subtotal` number, float, nullable, required: The total cost of labor for this record. - `subtotal` number, float, nullable, required: The pre-tax subtotal amount. - `tax_1_type` 'fixed' | 'percentage', nullable, required: The type of tax to apply to this record. - `tax_1_percentage` number, float, nullable, required: The primary tax percentage amount. This field should be present when `tax_1_type` is set to `percentage`. - `tax_2_type` 'fixed' | 'percentage', nullable, required: The type of tax to apply to this record. - `tax_2_percentage` number, float, nullable, required: 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](https://help.fleetio.com/s/article/Account-Settings#tax). - `tax_1` number, float, nullable, required: The primary tax amount. - `tax_2` number, float, nullable, required: The secondary tax amount. Note that this secondary tax must be configured in your [Account Settings](https://help.fleetio.com/s/article/Account-Settings#tax). - `parts_markup_type` 'fixed' | 'percentage': 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 - `parts_markup` number, float: The parts markup amount. Note that this is a readonly value that will default to `0.0` for non-premium plans - `parts_markup_percentage` number, float: 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 - `labor_markup_type` 'fixed' | 'percentage': 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 - `labor_markup` number, float: The labor markup amount. Note that this is a readonly value that will default to `0.0` for non-premium plans - `labor_markup_percentage` number, float: 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 - `total_amount` number, float, nullable, required: The total amount. - `labor_time_in_seconds` integer, nullable: The sum, in seconds, of the duration of all labor line items of a `completed` Work Order. - `comments` Comment[]: A list of the comments made on this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `commentable_type` 'Contact' | 'FleetcorCard' | 'FuelEntry' | 'InventoryJournalEntry' | 'Issue' | 'Part' | 'PurchaseOrder' | 'ServiceEntry' | 'ServiceReminder' | 'SubmittedInspectionItem' | 'Vehicle' | 'VehicleAssignment' | 'Vendor' | 'WexCard' | 'WorkOrder', required: The type of record that the Comment will be left on. Must be associated with a matching `commentable_id`. - `commentable_id` integer, required - `user_id` integer, required - `title` string: The title of the Comment. - `comment` string, required: The content of the Comment message body. - `user_full_name` string, required: The full name of the `User` who created the Comment. - `user_image_url` string, nullable, required: The image url for the `User` who created the Comment. - `rich_content` object, nullable, required - `html_content` string, nullable, required: The comment message body rendered as HTML. - `with_mentions` boolean, required: Indicates if the message body contains @mentions. - `comments_count` integer: The number of comments made on this record. - `images` Image2[]: A list of the images attached to this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `imageable_id` integer - `imageable_type` 'ExpenseEntry' | 'WorkOrder' | 'Equipment' | 'IssueResolution' | 'ServiceEntry' | 'Vendor' | 'ServiceProgram' | 'Issue' | 'Contact' | 'Part' | 'Vehicle' | 'FuelEntry' | 'SubmittedInspectionItem' - `file_name` string: The name of the image file. - `file_mime_type` '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_size` number: The size of the image file in bytes. - `file_url` string: The URL to access the image file. - `full_url` string: The full URL to access the image file, including any necessary authentication or parameters. - `images_count` integer: The number of images attached to this record. - `documents` Document[]: A list of the documents attached to this record. - `id` integer, required - `created_at` string, date-time: The date and time at which this record was created. - `updated_at` string, date-time: The date and time at which this record was most recently updated. - `name` string, required: The name of the document. - `description` string, required: The description of the document. - `documentable_id` integer, required - `documentable_type` 'ServiceEntry' | 'FuelEntry' | 'Issue' | 'WorkOrder' | 'ExpenseEntry' | 'Vehicle', required - `file_name` string, required: The name of the file. - `file_mime_type` string, required: The MIME type of the file. - `file_size` number, required: The size of the file in bytes. - `file_url` string, required: The URL to access the file. - `full_file_url` string, required: The full URL to access the file, including any necessary authentication or parameters. - `documents_count` integer: The number of documents attached to this record. ## Other responses - `401`: Request could not be authenticated - `403`: Insufficient permission to perform this operation - `404`: The requested resource could not be located - `500`: Something unexpected happened ## Changes - **2026-11-06** `49558d744bd7`: 6 info - added the optional property `allOf[subschema #2]/work_order_line_items/items/work_order_sub_line_items/items/anyOf[subschema #2: Work Order Sub Line Item]/allOf[subschema #2]/part/allOf[subschema #2]/cross_reference_group_id` to the response with the `200` status - added the optional property `allOf[subschema #2]/work_order_line_items/items/work_order_sub_line_items/items/anyOf[subschema #2: Work Order Sub Line Item]/allOf[subschema #2]/part/allOf[subschema #2]/cross_reference_members` to the response with the `200` status - added the optional property `allOf[subschema #2]/work_order_sub_line_items/items/anyOf[subschema #2: Work Order Sub Line Item]/allOf[subschema #2]/part/allOf[subschema #2]/cross_reference_group_id` to the response with the `200` status - added the optional property `allOf[subschema #2]/work_order_sub_line_items/items/anyOf[subschema #2: Work Order Sub Line Item]/allOf[subschema #2]/part/allOf[subschema #2]/cross_reference_members` to the response with the `200` status - …2 more - …earlier changes not shown [Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/work_orders/:id/get.md) --- [API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)