List Tires

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

Returns a list of Tires

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.
axle_config_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
vehicle_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
part_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
tire_position_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
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
axle_config_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD2
vehicle_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD3
part_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD4
tire_position_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD5
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD6
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
The id of the Tire
Example: 1
tire_position_idintegernullablerequired
A Tire Position id. The existence of a tire_position_id indicates this Tire is currently installed. Similiarly, if this value is null, then this Tire is not currently installed on a Vehicle.
Example: 1
part_idintegernullablerequired
A Part id.
Example: 1
axle_config_idintegernullablerequired
An Axle Configuration id. The existence of a axle_config_id indicates this Tire is currently installed. Similiarly, if this value is null, then this Tire is not currently installed on a Vehicle.
Example: 1
pressureintegernullablerequired
The air pressure of the Tire in pounds per square inch (PSI)
Example: 32
tread_depthintegernullablerequired
The tread depth of the Tire in /32 inch.
Example: 12
current_meternumberrequired
The current meter of the Tire.
Example: 19250
created_atdate-timerequired
When the Tire was created
updated_atdate-timerequired
When the Tire was last updated
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "axle_config_id": {
        "include": "string"
      }
    },
    {
      "vehicle_id": {
        "include": "string"
      }
    },
    {
      "part_id": {
        "include": "string"
      }
    },
    {
      "tire_position_id": {
        "include": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 1,
      "tire_position_id": 1,
      "part_id": 1,
      "axle_config_id": 1,
      "pressure": 32,
      "tread_depth": 12,
      "current_meter": 19250,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

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/v1/tires' \
-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

axle_config_idincludeeq

vehicle_idincludeeq

part_idincludeeq

tire_position_idincludeeq

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!