Read Fleetio vehicles, work orders, service, issues, inspections, fuel, parts; log issues, meters.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: add a comment to an issue, work order, service entry, service reminder, vehicle or part. Fleetio notifies the watchers of that record (and anyone @mentioned in the text). Comments added here cannot be edited or deleted by this server. POST /comments.
Comment text.
Id of the record (not its number).
Type of the record to comment on.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: add a comment to an issue, work order, service entry, service reminder, vehicle or part. Fleetio notifies the watchers of that record (and anyone @mentioned in the text). Comments added here cannot be edited or deleted by this server. POST /comments.
| Argument | Type | Description |
|---|---|---|
| comment* | string | Comment text. |
| commentable_id* | integer | Id of the record (not its number). |
| commentable_type* | string | Type of the record to comment on. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"commentable_type",
"commentable_id",
"comment"
],
"properties": {
"comment": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Comment text."
},
"commentable_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record (not its number).",
"exclusiveMinimum": 0
},
"commentable_type": {
"enum": [
"Issue",
"WorkOrder",
"ServiceEntry",
"ServiceReminder",
"Vehicle",
"Part"
],
"type": "string",
"description": "Type of the record to comment on."
}
}
}WRITE: create a new issue (a reported defect) on a vehicle or equipment. Fleetio may notify the people who watch or are assigned to it. Needs the asset id (fleetio_list_vehicles) and a summary; the report time defaults to now. Does not close, resolve or delete anything. POST /issues.
| Argument | Type | Description |
|---|---|---|
| summary* | string | Short summary of the problem. |
| asset_id* | integer | Id of the vehicle or equipment the issue is about. |
| due_date | string | When it should be resolved by (ISO 8601). |
| asset_type | string | Asset type (default Vehicle). |
| description | string | Longer description. |
| reported_at | string | When the issue was reported (ISO 8601, default now). |
| reported_by_id | integer | Contact id of the reporter. |
| issue_priority_id | integer | Priority id (fleetio_list_issue_priorities). |
WRITE: record an odometer / engine-hour meter reading for a vehicle (primary meter, or the secondary meter with secondary=true). Fleetio rejects a value that breaks the sequence (a reading must not be lower than an earlier one by date); it cannot be deleted from here. The date defaults to now. A new reading can make service reminders due or overdue, and Fleetio may notify their watchers. POST /meter_entries.
| Argument | Type | Description |
|---|---|---|
| date | string | When the reading was taken (ISO 8601, default now). |
| value* | number | Meter value in the vehicle's meter unit (miles, km or hours). |
| secondary | boolean | true = the vehicle's secondary meter (default: primary). |
| vehicle_id* | integer | Vehicle id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicle_id",
"value"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "When the reading was taken (ISO 8601, default now)."
},
"value": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Meter value in the vehicle's meter unit (miles, km or hours)."
},
"secondary": {
"type": "boolean",
"description": "true = the vehicle's secondary meter (default: primary)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id.",
"exclusiveMinimum": 0
}
}
}One contact (driver/technician/employee). Birth date and driver-licence data are never returned. GET /contacts/{id}.
| Argument | Type | Description |
|---|---|---|
| contact_id* | any | Contact id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"contact_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Contact id."
}
}
}One equipment record with full detail. GET /equipment/{id}.
| Argument | Type | Description |
|---|---|---|
| equipment_id* | any | Equipment id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"equipment_id"
],
"properties": {
"equipment_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Equipment id."
}
}
}One inspection form template with its items. GET /inspection_forms/{id}.
| Argument | Type | Description |
|---|---|---|
| inspection_form_id* | any | Inspection form id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inspection_form_id"
],
"properties": {
"inspection_form_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Inspection form id."
}
}
}One issue with full detail (state, priority, asset, reporter, due date, resolution). Optionally include comments, labels, the asset, custom fields, documents or images. GET /issues/{id}.
| Argument | Type | Description |
|---|---|---|
| includes | array | Extra attributes to include. |
| issue_id* | any | Issue id (not the issue number). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"issue_id"
],
"properties": {
"includes": {
"type": "array",
"items": {
"enum": [
"asset",
"comments",
"custom_fields",
"documents",
"images",
"labels"
],
"type": "string"
},
"maxItems": 6,
"description": "Extra attributes to include."
},
"issue_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Issue id (not the issue number)."
}
}
}One part with full detail (number, manufacturer, category, costs). GET /parts/{id}.
| Argument | Type | Description |
|---|---|---|
| part_id* | any | Part id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"part_id"
],
"properties": {
"part_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Part id."
}
}
}One service entry with full detail (vehicle, vendor, notes, meter readings, totals). GET /service_entries/{id}.
| Argument | Type | Description |
|---|---|---|
| service_entry_id* | any | Service entry id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"service_entry_id"
],
"properties": {
"service_entry_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Service entry id."
}
}
}One submitted inspection with every item's result (pass/fail/remarks), the vehicle, driver and any resulting work order. GET /submitted_inspection_forms/{id}.
| Argument | Type | Description |
|---|---|---|
| submitted_inspection_id* | any | Submitted inspection form id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"submitted_inspection_id"
],
"properties": {
"submitted_inspection_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Submitted inspection form id."
}
}
}One vehicle with full detail: status, type, group, meters, VIN, make/model/year, license plate, dates. GET /vehicles/{id}.
| Argument | Type | Description |
|---|---|---|
| vehicle_id* | any | Vehicle id (numeric). A VIN or license plate also works here, but only if external vehicle ids are set up in Fleetio; otherwise find the id with fleetio_list_vehicles. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicle_id"
],
"properties": {
"vehicle_id": {
"anyOf": [
{
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Fleetio numeric id."
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "Vehicle id (numeric). A VIN or license plate also works here, but only if external vehicle ids are set up in Fleetio; otherwise find the id with fleetio_list_vehicles."
}
}
}One vendor with full detail. GET /vendors/{id}.
| Argument | Type | Description |
|---|---|---|
| vendor_id* | any | Vendor id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vendor_id"
],
"properties": {
"vendor_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Vendor id."
}
}
}One work order with full detail (status, vendor, technician, dates, totals). GET /work_orders/{id}.
| Argument | Type | Description |
|---|---|---|
| work_order_id* | any | Work order id (not the work order number). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"work_order_id"
],
"properties": {
"work_order_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Work order id (not the work order number)."
}
}
}The Fleetio account(s) this API key belongs to: id, name, address, plan, units and the key's user type. The Account-Token and permission flags are never returned. GET /accounts.
| Argument | Type | Description |
|---|---|---|
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
}
}
}List comments left on records. Filter by the record: commentable_type (Issue, WorkOrder, ServiceEntry, Vehicle, ...) + commentable_id. GET /comments. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, updated_at. |
| user_id | integer | Author user id |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| commentable_id | integer | Id of the commented record |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| commentable_type | string | Type of the commented record. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, updated_at."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Author user id",
"exclusiveMinimum": 0
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"commentable_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the commented record",
"exclusiveMinimum": 0
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"commentable_type": {
"enum": [
"Issue",
"WorkOrder",
"ServiceEntry",
"ServiceReminder",
"Vehicle",
"Part",
"Contact",
"Vendor",
"VehicleAssignment"
],
"type": "string",
"description": "Type of the commented record."
}
}
}List contacts (drivers, technicians, employees) with name, email, phones, job title and group. Birth dates and driver-licence data are never returned. Filter by email, last name or group. GET /contacts. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| string | Email (contains, case-insensitive) | |
| sort_by | string | Sort field (default: Fleetio's default order). One of: group_id, created_at, updated_at, id. |
| group_id | integer | Group id |
| per_page | integer | Records per page, 2-100 (default 25). |
| last_name | string | Last name (contains, case-insensitive) |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| employee_number | string | Employee number |
| created_at_after |
List equipment (non-vehicle assets such as trailers and tools). GET /equipment. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Equipment name (contains, case-insensitive) |
| brand | string | Brand (contains, case-insensitive) |
| model | string | Model (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: created_at, updated_at, in_service_date, out_of_service_date, purchase_date, id. |
| group_id | integer | Group id |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| serial_number | string | Serial number (contains, case-insensitive) |
| sort_direction | string |
List diagnostic trouble codes (faults) reported by telematics devices, with vehicle, code and last occurrence. GET /faults. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| code | string | Fault code |
| name | string | Fault name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, last_occurred_at, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after |
List fuel purchases/fill-ups with vehicle, volume, price, total cost and efficiency. Filter by vehicle, vendor or date. Fuel-card data is never returned. GET /fuel_entries. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vendor_id | integer | Vendor id |
| date_after | string | Only records with fill-up date at or after this moment (ISO 8601). |
| vehicle_id | integer | Vehicle id |
| date_before | string | Only records with fill-up date at or before this moment (ISO 8601). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
Lookup: the groups (locations/departments) and their ids. GET /groups. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Group name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Group name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List the inspection form templates (for example a daily DVIR) defined in the account. GET /inspection_forms. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| title | string | Form title (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
Lookup: the issue priorities and their ids (needed to create an issue with a priority). GET /issue_priorities. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Priority name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Priority name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List issues (defects and problems reported against vehicles and equipment) with state, priority, assignees and due date. Filter by state, vehicle, equipment or reporter. GET /issues. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| state | string | Issue state. |
| number | integer | Issue number |
| sort_by | string | Sort field (default: Fleetio's default order). One of: due_date, resolved_at, reported_at, updated_at, created_at, id. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vehicle_id | integer | Vehicle id |
| equipment_id | integer | Equipment id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| due_date_after | string | Only records with due date at or after this moment (ISO 8601). |
| reported_by_id |
Lookup: the labels (tags) used on vehicles, issues, work orders and service entries. GET /labels. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Label name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Label name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List meter readings across the account. Filter by vehicle and by date. GET /meter_entries. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at. |
| category | string | Reading category. |
| per_page | integer | Records per page, 2-100 (default 25). |
| date_after | string | Only records with reading date at or after this moment (ISO 8601). |
| vehicle_id | integer | Vehicle id |
| date_before | string | Only records with reading date at or before this moment (ISO 8601). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
List on-hand inventory of parts per part location (quantity by location). Filter by part or part location. GET /part_location_details. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| part_id | integer | Part id |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| part_location_id | integer | Part location id |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"part_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Part id",
"exclusiveMinimum": 0
},
"sort_by": {
"enum": [
"id",
"created_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"part_location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Part location id",
"exclusiveMinimum": 0
}
}
}List parts (inventory catalog) with part number, manufacturer number, category and unit cost. Filter by part number, manufacturer part number or UPC. GET /parts. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| upc | string | UPC |
| number | string | Part number (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| part_category_id | integer | Part category id |
| updated_at_after |
List places (geofences/locations) with address, coordinates and radius. GET /places. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Place name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, name, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Place name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"name",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, name, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List service entries (completed maintenance records) with vehicle, vendor, dates and notes. Filter by reference or completion date. GET /service_entries. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, completed_at, updated_at, created_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| reference | string | Reference (contains, case-insensitive) |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
The line items (tasks, parts, labor) of ONE service entry. GET /service_entries/{id}/service_entry_line_items.
| Argument | Type | Description |
|---|---|---|
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| service_entry_id* | any | Service entry id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"service_entry_id"
],
"properties": {
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"service_entry_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Service entry id."
}
}
}List preventive-maintenance service reminders with next-due dates and meter values. Filter by status (ok, due_soon, overdue, snoozed), vehicle or service task. GET /service_reminders. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, next_due_at, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| service_task_id | integer | Service task id |
| service_reminder_status | string | Reminder status. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"next_due_at",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, next_due_at, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"service_task_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Service task id",
"exclusiveMinimum": 0
},
"service_reminder_status": {
"enum": [
"ok",
"due_soon",
"overdue",
"snoozed"
],
"type": "string",
"description": "Reminder status."
}
}
}Lookup: the service tasks (Oil Change, Tire Rotation, ...) and their ids. GET /service_tasks. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Task name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Task name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List submitted inspections (filled-in forms) with the vehicle, the driver, the number of failed items and the submit time. GET /submitted_inspection_forms. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: created_at, submitted_at, updated_at, id. |
| user_id | integer | Submitting user id |
| per_page | integer | Records per page, 2-100 (default 25). |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
List which driver (contact) was assigned to which vehicle and when; filter by vehicle or contact. GET /vehicle_assignments. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: started_at, ended_at, created_at, updated_at, id. |
| per_page | integer | Records per page, 2-100 (default 25). |
| contact_id | integer | Contact (driver) id |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| ended_at_after | string | Only records with assignment end at or after this moment (ISO 8601). |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| ended_at_before | string | Only records with assignment end at or before this moment (ISO 8601). |
List the odometer / engine-hour meter readings of ONE vehicle, newest first by default. GET /vehicles/{id}/meter_entries. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at. |
| category | string | Reading category. |
| per_page | integer | Records per page, 2-100 (default 25). |
| date_after | string | Only records with reading date at or after this moment (ISO 8601). |
| vehicle_id* | any | Vehicle id. |
| date_before | string | Only records with reading date at or before this moment (ISO 8601). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
List vehicle renewal reminders (registration, insurance, inspections due) with next-due dates. Filter by vehicle or status. GET /vehicle_renewal_reminders. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, due_soon_at, last_sent_at, next_due_at, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| next_due_at_after | string | Only records with next due date at or after this moment (ISO 8601). |
| next_due_at_before | string | Only records with next due date at or before this moment (ISO 8601). |
| vehicle_renewal_type_id | integer |
List the service entries of ONE vehicle. GET /vehicles/{id}/service_entries. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, completed_at, updated_at, created_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| reference | string | Reference (contains, case-insensitive) |
| vehicle_id* | any | Vehicle id. |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| completed_at_after | string | Only records with completion date at or after this moment (ISO 8601). |
| completed_at_before | string | Only records with completion date at or before this moment (ISO 8601). |
Lookup: the vehicle statuses (Active, In Shop, Out of Service, ...) and their ids for filtering vehicles. GET /vehicle_statuses. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Status name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Status name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}Lookup: the vehicle types (Car, Truck, Van, ...) and their ids. GET /vehicle_types. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Type name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Type name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List vehicles (not archived) with status, type, group, meter readings, VIN and license plate. Filter by name, VIN, plate, group, status or type; ids for the filters come from the lookup tools (fleetio_list_vehicle_statuses, fleetio_list_vehicle_types, fleetio_list_groups). GET /vehicles. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| vin | string | VIN (contains, case-insensitive) |
| name | string | Vehicle name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: name, created_at, updated_at, id. |
| group_id | integer | Group id |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| license_plate | string | License plate (contains, case-insensitive) |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
List vendors (repair shops, fuel stations, parts suppliers) with address and contact details. GET /vendors. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Vendor name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| external_id | string | External id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
The line items (labor, parts, fees) of ONE work order. GET /work_orders/{id}/work_order_line_items.
| Argument | Type | Description |
|---|---|---|
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| work_order_id* | any | Work order id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"work_order_id"
],
"properties": {
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"work_order_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Work order id."
}
}
}Lookup: the work order statuses (Open, In Progress, Completed, ...). GET /work_order_statuses. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| name | string | Status name (contains, case-insensitive) |
| sort_by | string | Sort field (default: Fleetio's default order). One of: id, created_at, updated_at. |
| per_page | integer | Records per page, 2-100 (default 25). |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Status name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}List work orders (shop jobs) with status, vehicle, vendor and technician. Filter by vehicle, vendor, technician, number or status name (for example Open). A finished work order produces a service entry. GET /work_orders. Returns one page (keyset paging: pass next_cursor as start_cursor).
| Argument | Type | Description |
|---|---|---|
| number | integer | Work order number |
| sort_by | string | Sort field (default: Fleetio's default order). One of: created_at, updated_at, id. |
| per_page | integer | Records per page, 2-100 (default 25). |
| vendor_id | integer | Vendor id |
| contact_id | integer | Technician (contact) id |
| vehicle_id | integer | Vehicle id |
| start_cursor | string | Cursor from the previous reply's next_cursor; omit for the first page. |
| invoice_number | string | Invoice number |
| sort_direction | string |
| assigned_contact_ids |
| array |
| Contact ids to assign (max 10). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"asset_id",
"summary"
],
"properties": {
"summary": {
"type": "string",
"maxLength": 250,
"minLength": 1,
"description": "Short summary of the problem."
},
"asset_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the vehicle or equipment the issue is about.",
"exclusiveMinimum": 0
},
"due_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "When it should be resolved by (ISO 8601)."
},
"asset_type": {
"enum": [
"Vehicle",
"Equipment"
],
"type": "string",
"description": "Asset type (default Vehicle)."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "Longer description."
},
"reported_at": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "When the issue was reported (ISO 8601, default now)."
},
"reported_by_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Contact id of the reporter.",
"exclusiveMinimum": 0
},
"issue_priority_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Priority id (fleetio_list_issue_priorities).",
"exclusiveMinimum": 0
},
"assigned_contact_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 10,
"description": "Contact ids to assign (max 10)."
}
}
}| string |
| Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Email (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"group_id",
"created_at",
"updated_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: group_id, created_at, updated_at, id."
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Group id",
"exclusiveMinimum": 0
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Last name (contains, case-insensitive)"
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Employee number"
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
}
}
}| Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Equipment name (contains, case-insensitive)"
},
"brand": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Brand (contains, case-insensitive)"
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Model (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"created_at",
"updated_at",
"in_service_date",
"out_of_service_date",
"purchase_date",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: created_at, updated_at, in_service_date, out_of_service_date, purchase_date, id."
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Group id",
"exclusiveMinimum": 0
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"serial_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Serial number (contains, case-insensitive)"
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
}
}
}| string |
| Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| last_occurred_at_after | string | Only records with last occurrence at or after this moment (ISO 8601). |
| last_occurred_at_before | string | Only records with last occurrence at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"code": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fault code"
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fault name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"last_occurred_at",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, last_occurred_at, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"last_occurred_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last occurrence at or after this moment (ISO 8601)."
},
"last_occurred_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last occurrence at or before this moment (ISO 8601)."
}
}
}| created_at_after |
| string |
| Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"date",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vendor_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vendor id",
"exclusiveMinimum": 0
},
"date_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with fill-up date at or after this moment (ISO 8601)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"date_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with fill-up date at or before this moment (ISO 8601)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
}
}
}| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Form title (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
}
}
}| integer |
| Reporter (contact) id |
| sort_direction | string | Sort direction (default asc; used with sort_by). |
| due_date_before | string | Only records with due date at or before this moment (ISO 8601). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| reported_at_after | string | Only records with report time at or after this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| reported_at_before | string | Only records with report time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"state": {
"enum": [
"open",
"resolved",
"closed"
],
"type": "string",
"description": "Issue state."
},
"number": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Issue number",
"exclusiveMinimum": 0
},
"sort_by": {
"enum": [
"due_date",
"resolved_at",
"reported_at",
"updated_at",
"created_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: due_date, resolved_at, reported_at, updated_at, created_at, id."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"equipment_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Equipment id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"due_date_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with due date at or after this moment (ISO 8601)."
},
"reported_by_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Reporter (contact) id",
"exclusiveMinimum": 0
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"due_date_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with due date at or before this moment (ISO 8601)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"reported_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with report time at or after this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"reported_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with report time at or before this moment (ISO 8601)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"date",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at."
},
"category": {
"enum": [
"starting",
"ending",
"nightly",
"manual"
],
"type": "string",
"description": "Reading category."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"date_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with reading date at or after this moment (ISO 8601)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"date_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with reading date at or before this moment (ISO 8601)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}| string |
| Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| manufacturer_part_number | string | Manufacturer part number (contains, case-insensitive) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"upc": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "UPC"
},
"number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Part number (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"part_category_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Part category id",
"exclusiveMinimum": 0
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"manufacturer_part_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Manufacturer part number (contains, case-insensitive)"
}
}
}| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| completed_at_after | string | Only records with completion date at or after this moment (ISO 8601). |
| completed_at_before | string | Only records with completion date at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"completed_at",
"updated_at",
"created_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, completed_at, updated_at, created_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"reference": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Reference (contains, case-insensitive)"
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"completed_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with completion date at or after this moment (ISO 8601)."
},
"completed_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with completion date at or before this moment (ISO 8601)."
}
}
}| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| inspection_form_id | integer | Inspection form id |
| submitted_at_after | string | Only records with submit time at or after this moment (ISO 8601). |
| submitted_at_before | string | Only records with submit time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"created_at",
"submitted_at",
"updated_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: created_at, submitted_at, updated_at, id."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Submitting user id",
"exclusiveMinimum": 0
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"inspection_form_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Inspection form id",
"exclusiveMinimum": 0
},
"submitted_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with submit time at or after this moment (ISO 8601)."
},
"submitted_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with submit time at or before this moment (ISO 8601)."
}
}
}| started_at_after |
| string |
| Only records with assignment start at or after this moment (ISO 8601). |
| started_at_before | string | Only records with assignment start at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"started_at",
"ended_at",
"created_at",
"updated_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: started_at, ended_at, created_at, updated_at, id."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Contact (driver) id",
"exclusiveMinimum": 0
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"ended_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with assignment end at or after this moment (ISO 8601)."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"ended_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with assignment end at or before this moment (ISO 8601)."
},
"started_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with assignment start at or after this moment (ISO 8601)."
},
"started_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with assignment start at or before this moment (ISO 8601)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicle_id"
],
"properties": {
"sort_by": {
"enum": [
"id",
"date",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, date, created_at, updated_at."
},
"category": {
"enum": [
"starting",
"ending",
"nightly",
"manual"
],
"type": "string",
"description": "Reading category."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"date_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with reading date at or after this moment (ISO 8601)."
},
"vehicle_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Vehicle id."
},
"date_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with reading date at or before this moment (ISO 8601)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
}
}
}| Renewal type id |
| vehicle_renewal_reminder_status | string | Reminder status. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort_by": {
"enum": [
"id",
"due_soon_at",
"last_sent_at",
"next_due_at",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, due_soon_at, last_sent_at, next_due_at, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"next_due_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with next due date at or after this moment (ISO 8601)."
},
"next_due_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with next due date at or before this moment (ISO 8601)."
},
"vehicle_renewal_type_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Renewal type id",
"exclusiveMinimum": 0
},
"vehicle_renewal_reminder_status": {
"enum": [
"ok",
"due_soon",
"overdue"
],
"type": "string",
"description": "Reminder status."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicle_id"
],
"properties": {
"sort_by": {
"enum": [
"id",
"completed_at",
"updated_at",
"created_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, completed_at, updated_at, created_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"reference": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Reference (contains, case-insensitive)"
},
"vehicle_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "string",
"pattern": "^[0-9]{1,18}$"
}
],
"description": "Vehicle id."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"completed_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with completion date at or after this moment (ISO 8601)."
},
"completed_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with completion date at or before this moment (ISO 8601)."
}
}
}| vehicle_type_id | integer | Vehicle type id |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| vehicle_status_id | integer | Vehicle status id |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"vin": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "VIN (contains, case-insensitive)"
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Vehicle name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"name",
"created_at",
"updated_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: name, created_at, updated_at, id."
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Group id",
"exclusiveMinimum": 0
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"license_plate": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "License plate (contains, case-insensitive)"
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"vehicle_type_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle type id",
"exclusiveMinimum": 0
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"vehicle_status_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle status id",
"exclusiveMinimum": 0
}
}
}| created_at_before |
| string |
| Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Vendor name (contains, case-insensitive)"
},
"sort_by": {
"enum": [
"id",
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: id, created_at, updated_at."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"external_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "External id"
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
}
}
}| Sort direction (default asc; used with sort_by). |
| created_at_after | string | Only records with creation time at or after this moment (ISO 8601). |
| updated_at_after | string | Only records with last update time at or after this moment (ISO 8601). |
| created_at_before | string | Only records with creation time at or before this moment (ISO 8601). |
| updated_at_before | string | Only records with last update time at or before this moment (ISO 8601). |
| purchase_order_number | string | Purchase order number |
| work_order_status_name | string | Work order status name (see fleetio_list_work_order_statuses) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"number": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Work order number",
"exclusiveMinimum": 0
},
"sort_by": {
"enum": [
"created_at",
"updated_at",
"id"
],
"type": "string",
"description": "Sort field (default: Fleetio's default order). One of: created_at, updated_at, id."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 2,
"description": "Records per page, 2-100 (default 25)."
},
"vendor_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vendor id",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Technician (contact) id",
"exclusiveMinimum": 0
},
"vehicle_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Vehicle id",
"exclusiveMinimum": 0
},
"start_cursor": {
"type": "string",
"maxLength": 1000,
"description": "Cursor from the previous reply's next_cursor; omit for the first page."
},
"invoice_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Invoice number"
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc; used with sort_by)."
},
"created_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or after this moment (ISO 8601)."
},
"updated_at_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or after this moment (ISO 8601)."
},
"created_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with creation time at or before this moment (ISO 8601)."
},
"updated_at_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,9})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records with last update time at or before this moment (ISO 8601)."
},
"purchase_order_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Purchase order number"
},
"work_order_status_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Work order status name (see fleetio_list_work_order_statuses)"
}
}
}