Skip to main content

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

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • name string

    The name for this Equipment.

  • brand string

    The name of the brand which makes this Equipment.

  • model string

    The model name of this Equipment.

  • serial_number string

    The serial number of this Equipment.

  • equipment_type_id integer

    Possible values: >= 1

  • type_name string

    The name of the associated Equipment Type.

  • equipment_status_id integer

    Possible values: >= 1

  • status_name string

    The name of the associated Equipment Status.

  • group_id NullableId

    Possible values: >= 1

  • group_name string

    The name of the associated Group.

  • purchase_vendor_id NullableId

    Possible values: >= 1

  • purchase_price_cents integer

    The purchase price in cents.

  • purchase_date date

    The date on which the Equipment was purchased.

  • estimated_resale_price float

    The estimated resale price of this Equipment.

  • warranty_expiration_date date

    The date on which the Equipment warranty expires.

  • purchase_comments string

    Any comments about the purchase of this Equipment.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • in_service_date date

    The date on which the Equipment was put into service.

  • estimated_service_life integer

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

  • out_of_service_date date

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

  • archived_at date-time

    The date and time at which the Equipment was archived.

  • status_color string

    The color of the associated Equipment Status.

  • linked_vehicle object
    oneOf
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • account_id integer

    Possible values: >= 1

  • archived_at date-time

    The date and time at which the Vehicle was archived.

  • fuel_type_id NullableId

    Possible values: >= 1

  • fuel_type_name string

    The name of the Fuel Type associated with this Vehicle.

  • fuel_volume_units VolumeUnit

    Possible values: [us_gallons, uk_gallons, liters]

  • group_id NullableId

    Possible values: >= 1

  • group_name string

    The name of the Group associated with this Vehicle.

  • meter_unit MeterUnit

    Possible values: [km, hr, mi]

    The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

  • name string

    This Vehicle's name.

  • ownership VehicleOwnership

    Possible values: [Owned, owned, leased, Leased, rented, Rented, customer, Customer]

  • secondary_meter boolean

    Indicates whether or not this Vehicle has a secondary meter.

  • secondary_meter_unit MeterUnit

    Possible values: [km, hr, mi]

    The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

  • system_of_measurement MeasurementSystem

    Possible values: [imperial, metric]

  • vehicle_status_id integer

    Possible values: >= 1

  • vehicle_status_name string

    The name of the Vehicle Status associated with this Vehicle.

  • vehicle_status_color string

    The color of the Vehicle Status associated with this Vehicle.

  • vehicle_type_id integer

    Possible values: >= 1

  • vehicle_type_name string

    The name of the Vehicle Type associated with this Vehicle.

  • fuel_entries_count integer

    The number of Fuel Entries associated with this Vehicle.

  • service_entries_count integer

    The number of Service Entries associated with this Vehicle.

  • service_reminders_count integer

    The number of Service Reminders associated with this Vehicle.

  • vehicle_renewal_reminders_count integer

    The number of Vehicle Renewal Reminders associated with this Vehicle.

  • comments_count integer

    The number of Comments associated with this Vehicle.

  • documents_count integer

    The number of documents attached to this Vehicle.

  • images_count integer

    The number of images attached to this Vehicle.

  • current_location_entry_id NullableId

    Possible values: >= 1

  • is_sample boolean

    Indicates whether this Vehicle record is Sample Data.

  • in_service_date date-time

    The date on which this Vehicle was put into service.

  • in_service_meter float

    The meter value at which this Vehicle was put into service.

  • estimated_service_months integer

    The estimated number of months this Vehicle will be in service.

  • estimated_replacement_mileage string

    The estimated number of miles before which this Vehicle will be replaced.

  • estimated_resale_price object

    The estimated resale price of this Vehicle.

  • cents integer

    The estimated resale price of this Vehicle in cents.

  • currency_iso string

    The ISO 4217 currency code of the estimated resale price.

  • out_of_service_date date-time

    The date on which this Vehicle was or will be retired.

  • out_of_service_meter float

    The meter value at which this Vehicle was or will be retired.

  • meter_name string

    The name of the primary meter for this Vehicle.

  • secondary_meter_name string

    The name of the secondary meter for this Vehicle.

  • primary_meter_usage_per_day string

    The average number of units of the primary meter used per day.

  • secondary_meter_usage_per_day string

    The average number of units of the secondary meter used per day.

  • current_meter_value float

    The current value of the primary meter for this Vehicle.

  • current_meter_date date-time

    The date and time at which the primary meter was last updated.

  • secondary_meter_value float

    The current value of the secondary meter for this Vehicle.

  • secondary_meter_date date-time

    The date and time at which the secondary meter was last updated.

  • group_ancestry string

    The ancestry of the Group associated with this Vehicle.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • loan_account_number string

    The account number for this Vehicle's loan, if applicable.

  • loan_ended_at date-time

    The date and time at which this Vehicle's loan ends.

  • loan_interest_rate float

    The interest rate for this Vehicle's loan.

  • loan_notes string

    Notes about this Vehicle's loan.

  • loan_started_at date-time

    The date and time at which this Vehicle's loan began. Formatted according to ISO-8601 in User's local time.

  • loan_vendor_id NullableId

    Possible values: >= 1

  • loan_vendor_name string

    The name of the Vendor for this Vehicle's loan.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • inspection_schedules_count integer

    The number of inspection schedules this Vehicle is associated with.

  • issues_count integer

    The number of Issues this Vehicle is associated with.

  • work_orders_count integer

    The number of Work Orders this Vehicle is associated with.

  • type_name string

    The name of the Vehicle Type associated with this Vehicle.

  • default_image_url string

    The URL of the default image for this Vehicle.

  • default_image_url_medium string

    The URL of a medium-sized version of the default image for this Vehicle.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

  • default_image_url_large string

    The URL of a large-sized version of the default image for this Vehicle.

  • specs object
  • id integer

    Possible values: >= 1

  • vehicle_id integer

    The Vehicle ID these specs belong to.

  • account_id integer
  • body_type string

    The body type of the Vehicle, if available.

  • body_subtype string

    The subtype of the Vehicle body, if available.

  • drive_type string

    The drive type of the Vehicle, if available.

  • brake_system string

    The brake system used in the Vehicle, if available.

  • msrp_cents integer

    The Manufacturer's Suggested Retail Price (MSRP) in cents, if available.

  • fuel_tank_capacity float

    The fuel tank capacity of the Vehicle, if available.

  • fuel_tank_2_capacity float

    The capacity of a second fuel tank, if available.

  • front_track_width float

    The front track width of the Vehicle, if available.

  • ground_clearance float

    The ground clearance of the Vehicle, if available.

  • height float

    The height of the Vehicle, if available.

  • length float

    The length of the Vehicle, if available.

  • rear_track_width float

    The rear track width of the Vehicle, if available.

  • width float

    The width of the Vehicle, if available.

  • wheelbase float

    The wheelbase of the Vehicle, if available.

  • front_tire_psi string

    The recommended PSI for front tires, if available.

  • rear_tire_psi string

    The recommended PSI for rear tires, if available.

  • base_towing_capacity string

    The base towing capacity of the Vehicle, if available.

  • curb_weight float

    The curb weight of the Vehicle, if available.

  • gross_vehicle_weight_rating float

    The Gross Vehicle Weight Rating (GVWR), if available.

  • bed_length string

    The length of the Vehicle's bed, if available.

  • max_payload string

    The maximum payload capacity of the Vehicle, if available.

  • rear_axle_type string

    The type of rear axle used in the Vehicle.

  • front_tire_type string

    The type of front tires used in the Vehicle.

  • front_wheel_diameter string

    The diameter of the front wheels.

  • rear_tire_type string

    The type of rear tires used in the Vehicle.

  • rear_wheel_diameter string

    The diameter of the rear wheels.

  • epa_city float

    The EPA city fuel economy rating, if available.

  • epa_highway float

    The EPA highway fuel economy rating, if available.

  • epa_combined float

    The combined EPA fuel economy rating, if available.

  • engine_description string

    Description of the Vehicle's engine.

  • engine_brand string

    Brand of the Vehicle's engine.

  • engine_aspiration string

    Aspiration type of the engine, if available.

  • engine_block_type string

    Block type of the engine, if available.

  • engine_bore string

    Bore size of the engine, if available.

  • engine_cam_type string

    Camshaft type of the engine, if available.

  • engine_compression string

    Compression ratio of the engine, if available.

  • engine_cylinders integer

    Number of engine cylinders, if available.

  • engine_displacement string

    Engine displacement, if available.

  • fuel_induction string

    Fuel induction method, if available.

  • fuel_quality string

    Fuel quality required for the engine.

  • max_hp string

    Maximum horsepower produced by the engine, if available.

  • max_torque string

    Maximum torque produced by the engine, if available.

  • oil_capacity string

    Oil capacity of the engine, if available.

  • redline_rpm string

    Redline RPM of the engine.

  • engine_stroke string

    Stroke length of the engine, if available.

  • engine_valves integer

    Number of engine valves, if available.

  • transmission_description string

    Description of the Vehicle's transmission.

  • transmission_brand string

    Brand of the Vehicle's transmission.

  • transmission_type string

    Type of transmission, if available.

  • transmission_gears integer

    Number of gears in the transmission, if available.

  • cargo_volume float

    Cargo volume of the Vehicle, if available.

  • interior_volume float

    Interior volume of the Vehicle, if available.

  • passenger_volume string

    Passenger volume of the Vehicle.

  • created_at date-time

    The date and time when the specs were created.

  • updated_at date-time

    The date and time when the specs were last updated.

  • duty_type string

    Type of duty the Vehicle is designed for, if available.

  • weight_class string

    Weight class of the Vehicle, if available.

  • engine_bore_with_units string

    Bore size of the engine with units, if available.

  • wheelbase_with_units string

    Wheelbase of the Vehicle with units, if available.

  • msrp string

    Manufacturer's Suggested Retail Price (MSRP).

  • external_ids object

    Any External IDs associated with this Vehicle.

  • ai_enabled boolean

    Whether this Vehicle has Auto Integrate enabled for it.

  • assetable_type string

    Possible values: [Vehicle]

    Assetable type for Vehicle is always Vehicle for vehicles.

  • driver object
  • id NullableId

    Possible values: >= 1

  • first_name string

    The first name of the Contact (driver) associated with this Vehicle.

  • last_name string

    The last name of the Contact (driver) associated with this Vehicle.

  • full_name string

    The full name of the Contact (driver) associated with this Vehicle.

  • default_image_url string

    The URL of the default image of the Contact (driver) associated with this Vehicle.

  • current_location_entry object

    The current location of the associated object.

  • id integer

    The unique identifier for the current Location Entry.

  • locatable_type string

    The type of object that this Location Entry is associated with.

  • locatable_id integer

    The unique identifier of the object that this Location Entry is associated with.

  • date date-time

    The date and time when this Location Entry was recorded.

  • created_at date-time

    The date and time when this Location Entry was created.

  • updated_at date-time

    The date and time when this Location Entry was last updated.

  • contact_id integer

    The unique identifier of the associated Contact.

  • address string

    The address associated with this Location Entry.

  • is_current boolean

    Indicates whether this Location Entry is the current location.

  • item_type string

    The type of item associated with this Location Entry.

  • item_id integer

    The unique identifier of the item associated with this Location Entry.

  • location string

    The geographical location in the format "POINT (longitude latitude)".

  • address_components object
  • street_number string

    The street number in the address.

  • street string

    The street name in the address.

  • city string

    The city in the address.

  • region string

    The region, state or province in the address.

  • region_short string

    The abbreviated region, state or province code.

  • country string

    The country in the address.

  • country_short string

    The abbreviated country code.

  • postal_code string

    The postal code, ZIP, or equivalent in the address.

  • geolocation object
  • latitude float

    The latitude coordinate of the location.

  • longitude float

    The longitude coordinate of the location.

  • loan_amount float

    The amount of this Vehicle's loan.

  • loan_payment float

    The amount of this Vehicle's loan payment.

  • warranties_active_count integer

    The number of active warranties associated with this Vehicle.

  • warranties_count integer

    The number of warranties associated with this Vehicle.

  • residual_value float

    The residual value of this Vehicle at the end of its lease.

  • axle_config_id integer

    The id of the Axle Configuration of this vehicle.

  • assigned_contact object
    oneOf
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • email string

    The Contact's email address.

  • name string

    The Contact's full name.

  • first_name string

    The Contact's first name.

  • middle_name string

    The Contact's middle name.

  • last_name string

    The Contact's last name.

  • images_count integer

    The number of images associated with this Contact.

  • documents_count integer

    The number of documents associated with this Contact.

  • comments_count integer

    The number of comments associated with this Contact.

  • group_id integer

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

  • group_name string

    If this Contact belongs to a Group, this will be the Group's name.

  • group_hierarchy string

    If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

  • technician boolean

    Whether or not the Contact is a Technician.

  • vehicle_operator boolean

    Whether or not the Contact is a Vehicle Operator.

  • employee boolean

    Whether or not the Contact is an Employee.

  • birth_date date

    The Contact's birth date.

  • street_address string

    The Contact's street address.

  • street_address_line_2 string

    The Contact's street address line 2.

  • city string

    The Contact's city.

  • region string

    The Contact's region, state, or province.

  • postal_code string

    The Contact's postal code, zip code, or equivalent.

  • country string

    The Contact's country.

  • employee_number string

    The Contact's employee number.

  • job_title string

    Possible values: <= 255 characters

    The Contact's job title.

  • license_class string

    The Contact's driver's license class.

  • license_number string

    The Contact's driver's license number.

  • license_state string

    The locality which issued the Contact's license.

  • license_expiration date

    The Contact's driver's license expiration date.

  • home_phone_number string

    The Contact's home phone number.

  • mobile_phone_number string

    The Contact's mobile phone number.

  • work_phone_number string

    The Contact's work phone number.

  • other_phone_number string

    Any other phone number for this Contact.

  • start_date date

    When the Contact started working for the company, if applicable.

  • leave_date date

    When the Contact left or will leave the company, if applicable.

  • hourly_labor_rate float

    The Contact's hourly rate.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • attachment_permissions object
  • read_photos boolean

    Indicates whether the user has read permission for photos.

  • manage_photos boolean

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

  • read_documents boolean

    Indicates whether the user has read permission for documents.

  • manage_documents boolean

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

  • default_image_url string

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

  • user object

    If the Contact is a Fleetio User, those details will be included here.

  • account_membership_id NullableId

    Possible values: >= 1

  • attachment_permissions object
  • read_photos boolean

    Indicates whether the user has read permission for photos.

  • manage_photos boolean

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

  • read_documents boolean

    Indicates whether the user has read permission for documents.

  • manage_documents boolean

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

  • default_image_url string

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

  • assetable_type string

    The type of assetable object.

  • issues_count integer

    The number of Issues associated with this Equipment.

  • current_location_entry object

    The current location of the associated object.

  • id integer

    The unique identifier for the current Location Entry.

  • locatable_type string

    The type of object that this Location Entry is associated with.

  • locatable_id integer

    The unique identifier of the object that this Location Entry is associated with.

  • date date-time

    The date and time when this Location Entry was recorded.

  • created_at date-time

    The date and time when this Location Entry was created.

  • updated_at date-time

    The date and time when this Location Entry was last updated.

  • contact_id integer

    The unique identifier of the associated Contact.

  • address string

    The address associated with this Location Entry.

  • is_current boolean

    Indicates whether this Location Entry is the current location.

  • item_type string

    The type of item associated with this Location Entry.

  • item_id integer

    The unique identifier of the item associated with this Location Entry.

  • location string

    The geographical location in the format "POINT (longitude latitude)".

  • address_components object
  • street_number string

    The street number in the address.

  • street string

    The street name in the address.

  • city string

    The city in the address.

  • region string

    The region, state or province in the address.

  • region_short string

    The abbreviated region, state or province code.

  • country string

    The country in the address.

  • country_short string

    The abbreviated country code.

  • postal_code string

    The postal code, ZIP, or equivalent in the address.

  • geolocation object
  • latitude float

    The latitude coordinate of the location.

  • longitude float

    The longitude coordinate of the location.

  • comments_count integer

    The number of Comments associated with this Equipment.

  • documents_count integer

    The number of documents associated with this Equipment.

  • images_count integer

    The number of images associated with this Equipment.

  • is_watched boolean

    Default value: false

    Indicates whether this Equipment is being watched.

  • watchers_count integer

    The number of users watching this Equipment.

Loading...