Skip to main content

List Work Orders

Returns a list of work orders.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return

  • filter object

    The fields, operations, and values to filter the records by.

    • contact_id object
    • eq string required
    • created_by_id object
    • eq string required
    • issued_by_id object
    • eq string required
    • vehicle_id object
    • eq string required
    • vendor_id object
    • eq string required
    • vmrs_repair_priority_class_id object
    • eq string required
    • purchase_order_number object
      oneOf
    • like string required
    • invoice_number object
      oneOf
    • like string required
    • number object
    • eq string required
    • labels object
    • include string required
    • work_order_status_name object
    • include string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

    • id string

      Possible values: [asc, desc]

      Default value: desc

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • contact_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • created_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • number string

    The unique number of this Work Order.

  • completed_at date-time

    The date and time at which the Work Order was completed.

  • description string

    A description of this Work Order.

  • ending_meter_same_as_start boolean

    Indicates whether or not the ending meter is the same as the starting meter.

  • duration_in_seconds integer

    The number of seconds elapsed between beginning this Work Order and completing it.

  • invoice_number string

    The number of the Invoice associated with this Work Order.

  • state string

    Possible values: [active, completed]

    Indicates whether this Work Order is currently active or has already been completed.

  • issued_at date-time

    The date and time at which the Work Order was issued.

  • issued_by_id integer

    The id of the issuer of this Work Order.

  • contact_id integer

    The id of the Contact assigned to this Work Order.

  • purchase_order_number string

    The purchase order number for this Work Order.

  • scheduled_at date-time

    The date and time at which the Work Order was scheduled.

  • started_at date-time

    The date and time at which the Work Order was started.

  • expected_completed_at date-time

    The date and time at which the Work Order is expected to be completed.

  • vehicle_id integer

    The id of the Vehicle associated with this Work Order.

  • work_order_status_id integer

    The id of the WorkOrderStatus for this Work Order.

  • work_order_status_color string

    The color of the Work Order Status for this Work Order.

  • work_order_status_name string

    The name of the Work Order Status for this Work Order.

  • documents_count integer

    The count of associated documents.

  • images_count integer

    The count of the associated images.

  • comments_count integer

    The count of associated comments.

  • created_at date-time

    The date and time at which the Work Order was created.

  • updated_at date-time

    The date and time at which the Work Order was last updated.

  • labor_time_in_seconds integer

    The sum, in seconds, of the duration of all labor line items of a completed Work Order.

  • attachment_permissions object
  • 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.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • contact object

    A Contact

  • id integer
  • email string

    The Contact's email address.

  • name string

    The Contact's full name.

  • group_id integer

    If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

  • default_image_url string

    The URL of the Contact's default image/profile photo, if any.

  • vehicle object

    A Vehicle

  • id integer
  • name string

    This vehicle's name.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

  • vendor object

    A Vendor

  • name string

    The name of the Vendor.

  • phone string

    The phone number of the Vendor.

  • city string

    The city of the Vendor.

  • region string

    The region, state, province, or territory of the Vendor.

  • postal_code string

    The postal code or ZIP code of the Vendor.

  • country string

    The country of the Vendor.

  • external_id string

    The external identifier of the Vendor.

Loading...