Skip to main content

List Vehicle Statuses

GET 

https://secure.fleetio.com/api/vehicle_statuses

Returns a list of Vehicle Statuses belonging to your account.

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.

    name object
    oneOf
    likestringrequired
    color object
    eqstringrequired
    created_at object
    oneOf
    ltstringrequired
    updated_at object
    oneOf
    ltstringrequired
    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

OK

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
    name object
    oneOf
    likestringrequired
  • ]
  • sorted_by object[]

    The sorts applied to the returned record set.

  • Array [
  • anyOf
    updated_atSortAscDesc (string)

    Possible values: [asc, desc]

  • ]
  • records object[]
  • Array [
  • idinteger

    Possible values: >= 1

    created_atdate-time

    The date and time at which this record was created.

    Example: 2023-03-14T13:46:27-06:00
    updated_atdate-time

    The date and time at which this record was most recently updated.

    Example: 2023-03-14T13:46:27-06:00
    account_idId (integer)required

    Possible values: >= 1

    namestringrequired

    The name of the Vehicle Status.

    defaultbooleanrequired

    Whether this is the default Vehicle Status for new Vehicles.

    colorstringnullablerequired

    The color of the Vehicle Status shown in the UI.

    positionintegernullablerequired

    The position of this Vehicle Status in the list of Vehicle Statuses.

  • ]

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 -L 'https://secure.fleetio.com/api/vehicle_statuses' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— query
— query
— query
name
coloreq
created_at
updated_at
— query
id
created_at
updated_at
ResponseClear

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