List Axle Configurations

GET 
https://secure.fleetio.com/api/axle_configs

Returns a list of Axle Configurations

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.
active object
eqstringrequired
Possible values: [true, false]
Default value: true
is_trailer object
eqstringrequired
Possible values: [true, false]
Default value: true
vehicle_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
axle_config_template_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
name object
oneOf
LikeFilter
likestringrequired
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.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, 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
active object
eqstringrequired
Possible values: [true, false]
Default value: true
MOD2
is_trailer object
eqstringrequired
Possible values: [true, false]
Default value: true
MOD3
vehicle_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD4
axle_config_template_id object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD5
name object
oneOf
IncludeFilter
includestringrequired
EqFilter
eqstringrequired
MOD6
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
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
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
namestring
This Axle Configuration's name.
Example: 4x4
descriptionstringnullable
This Axle Configuration's description.
Example: 4 wheel positions, 4 driven
axle_config_template_idintegernullable
The Id of the AxleConfigTemplate associated with this Axle Config.
vehicle_idinteger
The Id of the Vehicle associated with this Axle Config.
activeboolean
Whether this is the Vehicle's current active Axle Configuration
axles_countinteger
The count of Axles represented in this Axle Config.
is_trailerboolean
Whether or not this is Axle Config is for a trailer.
tire_positions_countinteger
The count of tire positions represented in this Axle Config.
tires_countinteger
The number of Tires represented in this Axle Config.
vehicle object
A Vehicle
idintegerrequired
namestringrequired
This vehicle's name.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "active": {
        "eq": "true"
      }
    },
    {
      "is_trailer": {
        "eq": "true"
      }
    },
    {
      "vehicle_id": {
        "include": "string"
      }
    },
    {
      "axle_config_template_id": {
        "include": "string"
      }
    },
    {
      "name": {
        "include": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "name": "4x4",
      "description": "4 wheel positions, 4 driven",
      "axle_config_template_id": 0,
      "vehicle_id": 0,
      "active": true,
      "axles_count": 0,
      "is_trailer": true,
      "tire_positions_count": 0,
      "tires_count": 0,
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      }
    }
  ]
}

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

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

activeeq

is_trailereq

vehicle_idincludeeq

axle_config_template_idincludeeq

namelikeeq

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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