Retrieve Equipment
Retrieve the details of an existing Equipment.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- 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
assigned_contact object
attachment_permissions object
- 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
- 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.
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"brand": "string",
"model": "string",
"serial_number": "string",
"equipment_type_id": 0,
"type_name": "string",
"equipment_status_id": 0,
"status_name": "string",
"group_id": 0,
"group_name": "string",
"purchase_vendor_id": 0,
"purchase_price_cents": 0,
"purchase_date": "2023-03-14",
"estimated_resale_price": 0,
"warranty_expiration_date": "2023-03-14",
"purchase_comments": "string",
"custom_fields": {},
"in_service_date": "2023-03-14",
"estimated_service_life": 0,
"out_of_service_date": "2023-03-14",
"archived_at": "2025-02-10",
"status_color": "string",
"linked_vehicle": {
"id": 0,
"created_at": "2025-02-10",
"updated_at": "2025-02-10",
"account_id": 0,
"archived_at": "2023-03-14T13:46:27-06:00",
"fuel_type_id": 0,
"fuel_type_name": "string",
"fuel_volume_units": "us_gallons",
"group_id": 0,
"group_name": "string",
"meter_unit": "km",
"name": "string",
"ownership": "Owned",
"secondary_meter": true,
"secondary_meter_unit": "km",
"system_of_measurement": "imperial",
"labels": [
{
"id": 0,
"name": "string",
"color": "#44DB38"
}
],
"vehicle_status_id": 0,
"vehicle_status_name": "string",
"vehicle_status_color": "string",
"vehicle_type_id": 0,
"vehicle_type_name": "string",
"fuel_entries_count": 0,
"service_entries_count": 0,
"service_reminders_count": 0,
"vehicle_renewal_reminders_count": 0,
"comments_count": 0,
"documents_count": 0,
"images_count": 0,
"current_location_entry_id": 0,
"is_sample": true,
"in_service_date": "2023-03-14T13:46:27-06:00",
"in_service_meter": 0,
"estimated_service_months": 0,
"estimated_replacement_mileage": "string",
"estimated_resale_price": {
"cents": 0,
"currency_iso": "string"
},
"out_of_service_date": "2023-03-14T13:46:27-06:00",
"out_of_service_meter": 0,
"meter_name": "string",
"secondary_meter_name": "string",
"primary_meter_usage_per_day": "string",
"secondary_meter_usage_per_day": "string",
"current_meter_value": 0,
"current_meter_date": "2023-03-14T13:46:27-06:00",
"secondary_meter_value": 0,
"secondary_meter_date": "2023-03-14T13:46:27-06:00",
"group_ancestry": "string",
"color": "string",
"license_plate": "string",
"vin": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"registration_expiration_month": 0,
"registration_state": "string",
"loan_account_number": "string",
"loan_ended_at": "2023-03-14T13:46:27-06:00",
"loan_interest_rate": 0,
"loan_notes": "string",
"loan_started_at": "2023-03-14T13:46:27-06:00",
"loan_vendor_id": 0,
"loan_vendor_name": "string",
"custom_fields": {},
"inspection_schedules_count": 0,
"issues_count": 0,
"work_orders_count": 0,
"type_name": "string",
"default_image_url": "string",
"default_image_url_medium": "string",
"default_image_url_small": "string",
"default_image_url_large": "string",
"specs": {
"id": 0,
"vehicle_id": 0,
"account_id": 0,
"body_type": "string",
"body_subtype": "string",
"drive_type": "string",
"brake_system": "string",
"msrp_cents": 0,
"fuel_tank_capacity": 0,
"fuel_tank_2_capacity": 0,
"front_track_width": 0,
"ground_clearance": 0,
"height": 0,
"length": 0,
"rear_track_width": 0,
"width": 0,
"wheelbase": 0,
"front_tire_psi": "string",
"rear_tire_psi": "string",
"base_towing_capacity": "string",
"curb_weight": 0,
"gross_vehicle_weight_rating": 0,
"bed_length": "string",
"max_payload": "string",
"rear_axle_type": "string",
"front_tire_type": "string",
"front_wheel_diameter": "string",
"rear_tire_type": "string",
"rear_wheel_diameter": "string",
"epa_city": 0,
"epa_highway": 0,
"epa_combined": 0,
"engine_description": "string",
"engine_brand": "string",
"engine_aspiration": "string",
"engine_block_type": "string",
"engine_bore": "string",
"engine_cam_type": "string",
"engine_compression": "string",
"engine_cylinders": 0,
"engine_displacement": "string",
"fuel_induction": "string",
"fuel_quality": "string",
"max_hp": "string",
"max_torque": "string",
"oil_capacity": "string",
"redline_rpm": "string",
"engine_stroke": "string",
"engine_valves": 0,
"transmission_description": "string",
"transmission_brand": "string",
"transmission_type": "string",
"transmission_gears": 0,
"cargo_volume": 0,
"interior_volume": 0,
"passenger_volume": "string",
"created_at": "2025-02-10",
"updated_at": "2025-02-10",
"duty_type": "string",
"weight_class": "string",
"engine_bore_with_units": "string",
"wheelbase_with_units": "string",
"msrp": "string"
},
"external_ids": {},
"ai_enabled": true,
"assetable_type": "Vehicle",
"driver": {
"id": 0,
"first_name": "string",
"last_name": "string",
"full_name": "string",
"default_image_url": "string"
},
"current_location_entry": {
"id": 0,
"locatable_type": "string",
"locatable_id": 0,
"date": "2025-02-10",
"created_at": "2025-02-10",
"updated_at": "2025-02-10",
"contact_id": 0,
"address": "string",
"is_current": true,
"item_type": "string",
"item_id": 0,
"location": "string",
"address_components": {
"street_number": "string",
"street": "string",
"city": "string",
"region": "string",
"region_short": "string",
"country": "string",
"country_short": "string",
"postal_code": "string"
},
"geolocation": {
"latitude": 0,
"longitude": 0
}
},
"loan_amount": 0,
"loan_payment": 0,
"warranties_active_count": 0,
"warranties_count": 0,
"residual_value": 0,
"axle_config_id": 0
},
"assigned_contact": {
"id": 0,
"created_at": "2025-02-10",
"updated_at": "2025-02-10",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"group_id": 0,
"group_name": "string",
"group_hierarchy": "Group 1|Group 2|Group 3",
"technician": true,
"vehicle_operator": true,
"employee": true,
"birth_date": "2023-03-14",
"street_address": "123 Main St",
"street_address_line_2": "Apt 1",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"employee_number": "string",
"job_title": "string",
"license_class": "string",
"license_number": "string",
"license_state": "string",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2025-02-10",
"leave_date": "2025-02-10",
"hourly_labor_rate": 0,
"custom_fields": {},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"user": {},
"account_membership_id": 0
},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"assetable_type": "string",
"issues_count": 0,
"current_location_entry": {
"id": 0,
"locatable_type": "string",
"locatable_id": 0,
"date": "2025-02-10",
"created_at": "2025-02-10",
"updated_at": "2025-02-10",
"contact_id": 0,
"address": "string",
"is_current": true,
"item_type": "string",
"item_id": 0,
"location": "string",
"address_components": {
"street_number": "string",
"street": "string",
"city": "string",
"region": "string",
"region_short": "string",
"country": "string",
"country_short": "string",
"postal_code": "string"
},
"geolocation": {
"latitude": 0,
"longitude": 0
}
},
"comments_count": 0,
"documents_count": 0,
"images_count": 0,
"is_watched": false,
"watchers_count": 0
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
GET /v1/equipment/:id
Request
Request
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'
curl -L -X GET 'https://secure.fleetio.com/api/v1/equipment/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-01-01'