Device Definitions API Endpoints

Developer Notes

🚧 The Device Definitions API endpoints are being to be deprecated and migrating to Identity API soon, please refrain from using the following REST API endpoints.

Base URLs

https://device-definitions-api.dev.dimo.zone


Device Definitions Lookup

Get Device Definitions by Make Model Year

GET {baseUrl}/device-definitions

Retrieves a specific device definition by make, model, and year of the vehicle.

Query Parameters

NameTypeDescription

make*

String

Make of the vehicle.

model*

String

Model of the vehicle.

year*

Number

Year of the vehicle.

{
    "deviceDefinitionId": "26G4j1YDKZhFeCsn12MAlyU3Y2H",
    "external_id": "lexus/nx",
    "name": "2021 Lexus NX",
    "imageUrl": "https://i.fuelapi.com/31271b03ca0f439190a0b8c6f47bc448/29313/2/2/color_1280_001/MY2021/14512/14512_cc1280_001_4Y1.jpg",
    "source": "parkers",
    "hardware_template_id": "",
    "make": {
        "id": "2681cTRIYnN4uTGARvAu9BCPis7",
        "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"
    },
    "type": {
        "type": "vehicle",
        "make": "Lexus",
        "model": "NX",
        "year": 2021,
        "subModels": null,
        "makeSlug": "lexus",
        "modelSlug": "nx"
    },
    "vehicleData": {},
    "metadata": "eyJ2ZWhpY2xlX2luZm8iOiB7Im1wZyI6ICIyNSIsICJtcGdfY2l0eSI6ICIyMiIsICJiYXNlX21zcnAiOiAiMzc2MTAiLCAiZnVlbF90eXBlIjogIkdhc29saW5lIiwgIndoZWVsYmFzZSI6ICIxMDUgV0IiLCAiZ2VuZXJhdGlvbiI6ICIxIiwgIm1wZ19oaWdod2F5IjogIjI4IiwgImRyaXZlbl93aGVlbHMiOiAiRldEIiwgIm51bWJlcl9vZl9kb29ycyI6ICI0IiwgInBvd2VydHJhaW5fdHlwZSI6ICJJQ0UiLCAibWFudWZhY3R1cmVyX2NvZGUiOiAiOTgyMCIsICJmdWVsX3RhbmtfY2FwYWNpdHlfZ2FsIjogIjE1LjkifX0=",
    "verified": true,
    "externalIds": [
        {
            "vendor": "parkers",
            "id": "lexus/nx"
        }
    ],
    "deviceIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "compatibleIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "deviceStyles": [],
    "deviceAttributes": [
        {
            "name": "<attribute_name>",
            "label": "",
            "description": "",
            "type": "",
            "required": false,
            "value": "<attribute_value>",
            "options": null
        }
    ]
}

Get Device Definitions by Device Definition ID

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

Retrieves a specific device definition by Device Definition ID.

Path Parameters

NameTypeDescription

deviceDefinitionId*

String

Device Definition ID

{
    "deviceDefinitionId": "26G4j1YDKZhFeCsn12MAlyU3Y2H",
    "external_id": "lexus/nx",
    "name": "2021 Lexus NX",
    "imageUrl": "https://i.fuelapi.com/31271b03ca0f439190a0b8c6f47bc448/29313/2/2/color_1280_001/MY2021/14512/14512_cc1280_001_4Y1.jpg",
    "source": "parkers",
    "hardware_template_id": "",
    "make": {
        "id": "2681cTRIYnN4uTGARvAu9BCPis7",
        "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"
    },
    "type": {
        "type": "vehicle",
        "make": "Lexus",
        "model": "NX",
        "year": 2021,
        "subModels": null,
        "makeSlug": "lexus",
        "modelSlug": "nx"
    },
    "vehicleData": {},
    "metadata": "eyJ2ZWhpY2xlX2luZm8iOiB7Im1wZyI6ICIyNSIsICJtcGdfY2l0eSI6ICIyMiIsICJiYXNlX21zcnAiOiAiMzc2MTAiLCAiZnVlbF90eXBlIjogIkdhc29saW5lIiwgIndoZWVsYmFzZSI6ICIxMDUgV0IiLCAiZ2VuZXJhdGlvbiI6ICIxIiwgIm1wZ19oaWdod2F5IjogIjI4IiwgImRyaXZlbl93aGVlbHMiOiAiRldEIiwgIm51bWJlcl9vZl9kb29ycyI6ICI0IiwgInBvd2VydHJhaW5fdHlwZSI6ICJJQ0UiLCAibWFudWZhY3R1cmVyX2NvZGUiOiAiOTgyMCIsICJmdWVsX3RhbmtfY2FwYWNpdHlfZ2FsIjogIjE1LjkifX0=",
    "verified": true,
    "externalIds": [
        {
            "vendor": "parkers",
            "id": "lexus/nx"
        }
    ],
    "deviceIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "compatibleIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "deviceStyles": [],
    "deviceAttributes": [
        {
            "name": "<attribute_name>",
            "label": "",
            "description": "",
            "type": "",
            "required": false,
            "value": "<attribute_value>",
            "options": null
        }
    ]
}

Device Makes Lookup

List All Device Makes

GET {baseUrl}/device-makes

Retrieves a list of all device makes.

This is a long list, so I'm not going to display it for you...


Device Types Lookup

Get Device Types by ID

GET {baseUrl}/device-types/{deviceTypeId}

Retrieves a specific vehicle type by looking up the device identifier. This device identifier is a user-friendly name to the type of devices, such as vehicle, aftermarket_device

Path Parameters

NameTypeDescription

deviceTypeId*

String

Device Type ID

{
    // Response
}

Swagger Doc

Last updated