Skip to main content

List Equipment

GET 

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

Returns a list of your Equipment. Defaults to only returning non-archived Equipment, but you can include archived Equipment in the results as well.

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.

    brand object
    oneOf
    likestringrequired
    name object
    oneOf
    likestringrequired
    model object
    oneOf
    likestringrequired
    serial_number object
    oneOf
    likestringrequired
    labels object
    includestringrequired
    current_location_entry_id object
    eqstringrequired
    group_id object
    eqstringrequired
    in_service_date object
    oneOf
    eqstringrequired
    out_of_service_date object
    oneOf
    eqstringrequired
    purchase_date object
    oneOf
    eqstringrequired
    created_at object
    oneOf
    ltstringrequired
    updated_at object
    oneOf
    ltstringrequired
    sort object

    The fields and direction to sort the results by.

    in_service_dateSortAscDesc (string)

    Possible values: [asc, desc]

    out_of_service_dateSortAscDesc (string)

    Possible values: [asc, desc]

    purchase_dateSortAscDesc (string)

    Possible values: [asc, desc]

    created_atSortAscDesc (string)

    Possible values: [asc, desc]

    updated_atSortAscDesc (string)

    Possible values: [asc, desc]

    idSortAscDescDefaultDesc (string)

    Possible values: [asc, desc]

    Default value: 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
    brand object
    oneOf
    likestringrequired
  • ]
  • sorted_by object[]

    The sorts applied to the returned record set.

  • Array [
  • anyOf
    in_service_dateSortAscDesc (string)

    Possible values: [asc, desc]

  • ]
  • records Equipment[]
  • Array [
  • idintegerrequired
    namestringrequired

    The name for this Equipment.

    brandstringnullablerequired

    The name of the brand which makes this Equipment.

    modelstringnullablerequired

    The model name of this Equipment.

    serial_numberstringnullablerequired

    The serial number of this Equipment.

    equipment_type_idintegerrequired
    type_namestringrequired

    The name of the associated Equipment Type.

    equipment_status_idintegerrequired
    status_namestringrequired

    The name of the associated Equipment Status.

    group_idintegernullablerequired
    purchase_vendor_idintegernullablerequired
    purchase_price_centsintegernullablerequired

    The purchase price in cents.

    purchase_datedatenullablerequired

    The date on which the Equipment was purchased.

    Example: 2023-03-14
    estimated_resale_price_centsintegernullablerequired

    The estimated resale price in cents of this Equipment.

    warranty_expiration_datedatenullablerequired

    The date on which the Equipment warranty expires.

    Example: 2023-03-14
    purchase_commentsstringnullablerequired

    Any comments about the purchase of this Equipment.

    custom_fieldsobjectnullable

    *Full details on working with Custom Fields here.

    in_service_datedatenullablerequired

    The date on which the Equipment was put into service.

    Example: 2023-03-14
    estimated_service_lifeintegernullablerequired

    The estimated duration in months of the service life for this Equipment.

    out_of_service_datedatenullablerequired

    The estimated date on which the Equipment will be retired from service.

    Example: 2023-03-14
    archived_atdate-timenullablerequired

    The date and time at which the Equipment was archived.

    status_colorstringnullablerequired

    The color of the associated Equipment Status.

    purchase_vendor objectnullable

    A Vendor

    namestringrequired

    The name of the Vendor.

    phonestringnullablerequired

    The phone number of the Vendor.

    citystringnullablerequired

    The city of the Vendor.

    regionstringnullablerequired

    The region, state, province, or territory of the Vendor.

    postal_codestringnullablerequired

    The postal code or ZIP code of the Vendor.

    countrystringnullablerequired

    The country of the Vendor.

    external_idstringnullablerequired

    The external identifier of the Vendor.

    linked_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.

    assigned_contact objectnullable

    A Contact

    idintegerrequired
    emailstringnullable

    The Contact's email address.

    namestringnullablerequired

    The Contact's full name.

    group_idintegernullable

    If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

    default_image_urlstringnullablerequired

    The URL of the Contact's default image/profile photo, if any.

    attachment_permissions objectnullablerequired
    read_photosboolean

    Indicates whether the user has read permission for photos.

    manage_photosboolean

    Indicates whether the user has permission to manage (eg. upload, delete) photos.

    read_documentsboolean

    Indicates whether the user has read permission for documents.

    manage_documentsboolean

    Indicates whether the user has permission to manage (eg. upload, delete) documents.

    default_image_urlstringnullablerequired

    The URL of the Equipment's default image/profile photo, if any.

    assetable_typestringnullablerequired

    The type of assetable object.

    comments_countintegerrequired

    The number of Comments associated with this Equipment.

    Possible values: >= 0

    documents_countintegerrequired

    The number of documents associated with this Equipment.

    Possible values: >= 0

    images_countintegerrequired

    The number of images associated with this Equipment.

    Possible values: >= 0

    is_watchedbooleanrequired

    Indicates whether this Equipment is being watched.

    Default value: false
    watchers_countintegerrequired

    The number of users watching this Equipment.

    Possible values: >= 0

  • ]

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/equipment' \
-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
brand
name
model
serial_number
labelsinclude
current_location_entry_ideq
group_ideq
in_service_date
out_of_service_date
purchase_date
created_at
updated_at
— query
in_service_date
out_of_service_date
purchase_date
created_at
updated_at
id
ResponseClear

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