Device Definitions API

Device Definitions API

List All Device Definitions

GET {baseUrl}/device-definitions/all

Retrieves a list of all device definitions.

⚠️ This endpoint returns all the device definitions of all vehicles, the data volume is very large so please handle with care.

200: OK Successfully retrieved all device definitions.

401: Unauthorized Invalid or expired JWT.

List All Available Integrations for a Device Definition by Device Definition ID

GET {baseUrl}/device-definitions/{deviceDefinitionId}/integrations

Lists all available integrations for a specific device definition by Device Definition ID.

200: OK Successfully retrieved all available integrations for the particular device definition.

401: Unauthorized Invalid or expired JWT.

404: Not Found The device definition cannot be found.

500: Internal Server Error DIMO server errors.

Decode An Array of VINs Returning JSON

POST {baseUrl}/bulk-decode

Decodes a list of Vehicle Identification Numbers, returning in JSON format.

Request Body

Name	Type	Description
vins*	[String]	An array of Vehicle Identification Numbers (VIN).

200: OK Successfully decodes a list of VINs.

{
    "decoded_vins": [
        {
            "vin": "JTJGARBZ0M5023423",
            "device_definition_id": "26G4j1YDKZhFeCsn13MAlyU3Y2X",
            "device_make": {
                "id": "2681cTRIYnN3uTGARvXu9BCPis7",
                "name": "Lexus",
                "logo_url": null,
                "oem_platform_name": "Lexus Enform",
                "tokenId": 69,
                "nameSlug": "lexus",
                "external_ids": {
                    "edmunds": "200705856",
                    "parkers": "lexus"
                },
                "externalIdsTyped": [
                    {
                        "vendor": "edmunds",
                        "id": "200705856"
                    },
                    {
                        "vendor": "parkers",
                        "id": "lexus"
                    }
                ],
                "metadata": null,
                "metadataTyped": null,
                "hardware_template_id": null,
                "created_at": "0001-01-01T00:00:00Z",
                "updated_at": "0001-01-01T00:00:00Z"
            },
            "device_year": 2021,
            "device_model": "Standard Trim",
            "compatibility_features": [
                {
                    "features": [
                        {
                            "key": "location",
                            "support_level": 2,
                            "css_icon": "location_on",
                            "display_name": "Location"
                        },
                        {
                            "key": "odometer",
                            "support_level": 2,
                            "css_icon": "custom_odometer",
                            "display_name": "Odometer"
                        },
                        {
                            "key": "vin",
                            "support_level": 2,
                            "css_icon": "badge",
                            "display_name": "VIN"
                        }
                    ],
                    "level": "Bronze",
                    "integration_id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
                    "integration_vendor": "SmartCar",
                    "region": "Americas",
                    "score": 44.68085
                },
                {
                    "features": [
                        {
                            "key": "location",
                            "support_level": 2,
                            "css_icon": "location_on",
                            "display_name": "Location"
                        },
                        {
                            "key": "odometer",
                            "css_icon": "custom_odometer",
                            "display_name": "Odometer"
                        },
                        {
                            "key": "vin",
                            "support_level": 2,
                            "css_icon": "badge",
                            "display_name": "VIN"
                        },
                        {
                            "key": "speed",
                            "css_icon": "speed",
                            "display_name": "Speed"
                        }
                    ],
                    "level": "Bronze",
                    "integration_id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
                    "integration_vendor": "AutoPi",
                    "region": "Americas",
                    "score": 25.531916
                },
                {
                    "features": [
                        {
                            "key": "location",
                            "support_level": 1,
                            "css_icon": "location_on",
                            "display_name": "Location"
                        },
                        {
                            "key": "odometer",
                            "css_icon": "custom_odometer",
                            "display_name": "Odometer"
                        },
                        {
                            "key": "vin",
                            "support_level": 1,
                            "css_icon": "badge",
                            "display_name": "VIN"
                        },
                        {
                            "key": "range",
                            "display_name": "Range"
                        }
                    ],
                    "level": "No Data",
                    "integration_id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
                    "integration_vendor": "AutoPi",
                    "region": "Europe"
                }
            ]
        }
    ],
    "not_decoded_vins": []
}

404: Not Found

500: Internal Server Error

Decode An Array of VINs Returning CSV

POST {baseUrl}/bulk-decode/csv

Decodes a list of Vehicle Identification Numbers, returning in CSV format.

Request Body

Name	Type	Description
vins*	[String]	An array of Vehicle Identification Numbers (VIN).

200: OK Successfully decodes a list of VINs.

404: Not Found

500: Internal Server Error

---