Get car of product

GET

/products/{productId}/cars

const url = 'https://api-uat.flinkey.de/v3/products/1/cars';
const options = {
  method: 'GET',
  headers: {
    'Customer-ID': 'example',
    'flinkey-API-Key': '<flinkey-API-Key>',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-uat.flinkey.de/v3/products/1/cars \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Retrieve the car assigned to one specific product in the selected customer context.

A product represents a flinkey hardware product assigned to the customer context.

A car is the API abstraction used for vehicle-related access flows.

Use this operation for operational lookup, reconciliation and support workflows where the relationship between a product and a car must be inspected.

When to use this operation

Use this operation when the partner backend needs to retrieve the car assigned to a specific product.

Typical situations:

checking which car is assigned to a product,
reconciling hardware setup with car records,
supporting operational troubleshooting,
validating product-to-car assignment,
identifying car data from a known product reference,
checking vehicle metadata such as VIN, license plate, brand or model.

For standard access flows, the partner backend should usually work with Car, User and Assignment.

Use this operation only where product-level lookup is required.

Validation notes

The base request returned 200 OK with one car object despite the plural /cars path.
The returned car ID matched the carId exposed by the related product.
description was observed as null; vin, brand and model were observed as empty strings.
Collection-style OData options returned 400 Bad Request because the resource is not a collection.

Async behavior

Synchronous.

The car assigned to the product is returned directly in the API response.

Webhook result

No.

This operation does not produce a webhook result.

Security notes

Never log:

flinkey-API-Key,
bearer token,
full request headers.

Product and car identifiers are environment-specific.

Do not mix UAT and PROD product IDs or car IDs.

Use placeholders in documentation, examples, screenshots and AI prompts.

For standard partner integrations, the mobile app must not receive API Manager credentials, backend bearer tokens or the flinkey-API-Key.

Authorizations

apiKey
bearerAuth

Parameters

Path Parameters

productId

required

number

Database ID of the product

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Car assigned to the product was retrieved successfully

application/json

object

Car database ID

number

name

Car name

string

description

Car description

string | null

vin

Vehicle identification number

string | null

licensePlate

Vehicle license plate

string | null

brand

Vehicle brand

string | null

model

Vehicle model

string | null

Example

{
  "id": 12345,
  "name": "VW Golf Fleet-01",
  "description": "White VW Golf, 2024",
  "vin": "WVWZZZ1KZXW000001",
  "licensePlate": "B-FL 1234",
  "brand": "Volkswagen",
  "model": "Golf"
}

401

Invalid subscription key or missing / invalid access token

Recommended handling: Check flinkey-API-Key, bearer token and environment configuration

404

API Manager, customer context, product or assigned car was not found

Recommended handling: Check credentials, Customer-ID, local productId reference and product-to-car assignment

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent