List Work Orders

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

Returns a list of work orders.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return
Default value: 50
filter object
The fields, operations, and values to filter the records by.
contact_id object
eqstringrequired
created_by_id object
eqstringrequired
issued_by_id object
eqstringrequired
vehicle_id object
eqstringrequired
vendor_id object
eqstringrequired
vmrs_repair_priority_class_id object
eqstringrequired
purchase_order_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
invoice_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
number object
eqstringrequired
labels object
includestringrequired
work_order_status_name object
includestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object
The fields and direction to sort the results by.
created_atSortAscDesc (string)
Possible values: [asc, desc]
updated_atSortAscDesc (string)
Possible values: [asc, desc]
idSortAscDescDefaultDesc (string)
Possible values: [asc, desc]
Default value: desc

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
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.
Array [
anyOf
MOD1
contact_id object
eqstringrequired
MOD2
created_by_id object
eqstringrequired
MOD3
issued_by_id object
eqstringrequired
MOD4
vehicle_id object
eqstringrequired
MOD5
vendor_id object
eqstringrequired
MOD6
vmrs_repair_priority_class_id object
eqstringrequired
MOD7
purchase_order_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD8
invoice_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD9
number object
eqstringrequired
MOD10
labels object
includestringrequired
MOD11
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD12
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
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_idintegernullablerequired
The id of the issuer of this Work Order.
contact_idintegernullablerequired
The id of the Contact assigned to this Work Order.
purchase_order_numberstringnullablerequired
The purchase order number for this Work Order.
scheduled_atdate-timenullablerequired
The date and time at which the Work Order was scheduled.
Example: 2023-03-14T13:46:27-06:00
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-timenullablerequired
The date and time at which the Work Order is expected to be completed.
Example: 2023-03-14T13:46:27-06:00
vehicle_idintegerrequired
The id of the Vehicle associated with this Work Order.
work_order_status_idintegerrequired
The id of the WorkOrderStatus for this Work Order.
work_order_status_colorstringnullable
The color of the Work Order Status for this Work Order.
work_order_status_namestringrequired
The name of the Work Order Status for this Work Order.
documents_countintegerrequired
The count of associated documents.
images_countintegerrequired
The count of the associated images.
comments_countintegerrequired
The count of associated comments.
created_atdate-timerequired
The date and time at which the Work Order was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-timerequired
The date and time at which the Work Order was last updated.
Example: 2023-03-14T13:46:27-06:00
labor_time_in_secondsintegernullable
The sum, in seconds, of the duration of all labor line items of a completed Work Order.
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.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
contact objectnullablerequired
A Contact
idintegerrequired
emailstringnullable
The Contact's email address.
namestringnullablerequired
The Contact's full name.
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
default_image_urlstringnullablerequired
The URL of the Contact's default image/profile photo, if any.
vehicle objectrequired
A Vehicle
idintegerrequired
namestringrequired
This vehicle's name.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
vendor objectnullablerequired
A Vendor
namestringrequired
The name of the Vendor.
phonestringnullablerequired
The phone number of the Vendor.
citystringnullablerequired
The city of the Vendor.
regionstringnullablerequired
The region, state, province, or territory of the Vendor.
postal_codestringnullablerequired
The postal code or ZIP code of the Vendor.
countrystringnullablerequired
The country of the Vendor.
external_idstringnullablerequired
The external identifier of the Vendor.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "contact_id": {
        "eq": "string"
      }
    },
    {
      "created_by_id": {
        "eq": "string"
      }
    },
    {
      "issued_by_id": {
        "eq": "string"
      }
    },
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "vmrs_repair_priority_class_id": {
        "eq": "string"
      }
    },
    {
      "purchase_order_number": {
        "like": "string"
      }
    },
    {
      "invoice_number": {
        "like": "string"
      }
    },
    {
      "number": {
        "eq": "string"
      }
    },
    {
      "labels": {
        "include": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "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,
      "contact_id": 0,
      "purchase_order_number": "string",
      "scheduled_at": "2023-03-14T13:46:27-06:00",
      "started_at": "2023-03-14T13:46:27-06:00",
      "expected_completed_at": "2023-03-14T13:46:27-06:00",
      "vehicle_id": 0,
      "work_order_status_id": 0,
      "work_order_status_color": "string",
      "work_order_status_name": "string",
      "documents_count": 0,
      "images_count": 0,
      "comments_count": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "labor_time_in_seconds": 0,
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "custom_fields": {},
      "contact": {
        "id": 0,
        "email": "string",
        "name": "string",
        "group_id": 0,
        "default_image_url": "string"
      },
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      },
      "vendor": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

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/v2/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

Parameters

start_cursor — query

per_page — query

filter — query

contact_ideq

created_by_ideq

issued_by_ideq

vehicle_ideq

vendor_ideq

vmrs_repair_priority_class_ideq

purchase_order_numberlikeeq

invoice_numberlikeeq

numbereq

labelsinclude

work_order_status_nameinclude

created_atltltegtgte

updated_atltltegtgte

sort — query

created_at---ascdesc

updated_at---ascdesc

id---ascdesc

ResponseClear

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